src/apis/calendar/v3.ts
Properties |
|
| calendarId |
calendarId:
|
Type : string
|
| Optional |
|
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. |
| ruleId |
ruleId:
|
Type : string
|
| Optional |
|
ACL rule identifier. |
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosPromise,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace calendar_v3 {
export interface Options extends GlobalOptions {
version: 'v3';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Calendar API
*
* Manipulates events and other calendar data.
*
* @example
* ```js
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
* ```
*/
export class Calendar {
context: APIRequestContext;
acl: Resource$Acl;
calendarList: Resource$Calendarlist;
calendars: Resource$Calendars;
channels: Resource$Channels;
colors: Resource$Colors;
events: Resource$Events;
freebusy: Resource$Freebusy;
settings: Resource$Settings;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.acl = new Resource$Acl(this.context);
this.calendarList = new Resource$Calendarlist(this.context);
this.calendars = new Resource$Calendars(this.context);
this.channels = new Resource$Channels(this.context);
this.colors = new Resource$Colors(this.context);
this.events = new Resource$Events(this.context);
this.freebusy = new Resource$Freebusy(this.context);
this.settings = new Resource$Settings(this.context);
}
}
export interface Schema$Acl {
/**
* ETag of the collection.
*/
etag?: string | null;
/**
* List of rules on the access control list.
*/
items?: Schema$AclRule[];
/**
* Type of the collection ("calendar#acl").
*/
kind?: string | null;
/**
* Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string | null;
/**
* 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.
*/
nextSyncToken?: string | null;
}
export interface Schema$AclRule {
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* Identifier of the Access Control List (ACL) rule. See Sharing calendars.
*/
id?: string | null;
/**
* Type of the resource ("calendar#aclRule").
*/
kind?: string | null;
/**
* The role assigned to the scope. Possible values are:
* - "none" - Provides no access.
* - "freeBusyReader" - Provides read access to free/busy information.
* - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
* - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
* - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
role?: string | null;
/**
* The extent to which calendar access is granted by this ACL rule.
*/
scope?: {type?: string; value?: string} | null;
}
export interface Schema$Calendar {
/**
* Conferencing properties for this calendar, for example what types of conferences are allowed.
*/
conferenceProperties?: Schema$ConferenceProperties;
/**
* Description of the calendar. Optional.
*/
description?: string | null;
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
*/
id?: string | null;
/**
* Type of the resource ("calendar#calendar").
*/
kind?: string | null;
/**
* Geographic location of the calendar as free-form text. Optional.
*/
location?: string | null;
/**
* Title of the calendar.
*/
summary?: string | null;
/**
* The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
*/
timeZone?: string | null;
}
export interface Schema$CalendarList {
/**
* ETag of the collection.
*/
etag?: string | null;
/**
* Calendars that are present on the user's calendar list.
*/
items?: Schema$CalendarListEntry[];
/**
* Type of the collection ("calendar#calendarList").
*/
kind?: string | null;
/**
* Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string | null;
/**
* 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.
*/
nextSyncToken?: string | null;
}
export interface Schema$CalendarListEntry {
/**
* The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
* - "freeBusyReader" - Provides read access to free/busy information.
* - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
* - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
* - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
accessRole?: string | null;
/**
* 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.
*/
backgroundColor?: string | null;
/**
* 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.
*/
colorId?: string | null;
/**
* Conferencing properties for this calendar, for example what types of conferences are allowed.
*/
conferenceProperties?: Schema$ConferenceProperties;
/**
* The default reminders that the authenticated user has for this calendar.
*/
defaultReminders?: Schema$EventReminder[];
/**
* Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
*/
deleted?: boolean | null;
/**
* Description of the calendar. Optional. Read-only.
*/
description?: string | null;
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* 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.
*/
foregroundColor?: string | null;
/**
* 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.
*/
hidden?: boolean | null;
/**
* Identifier of the calendar.
*/
id?: string | null;
/**
* Type of the resource ("calendar#calendarListEntry").
*/
kind?: string | null;
/**
* Geographic location of the calendar as free-form text. Optional. Read-only.
*/
location?: string | null;
/**
* The notifications that the authenticated user is receiving for this calendar.
*/
notificationSettings?: {
notifications?: Schema$CalendarNotification[];
} | null;
/**
* Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
*/
primary?: boolean | null;
/**
* Whether the calendar content shows up in the calendar UI. Optional. The default is False.
*/
selected?: boolean | null;
/**
* Title of the calendar. Read-only.
*/
summary?: string | null;
/**
* The summary that the authenticated user has set for this calendar. Optional.
*/
summaryOverride?: string | null;
/**
* The time zone of the calendar. Optional. Read-only.
*/
timeZone?: string | null;
}
export interface Schema$CalendarNotification {
/**
* The method used to deliver the notification. The possible value is:
* - "email" - Notifications are sent via email.
* Required when adding a notification.
*/
method?: string | null;
/**
* The type of notification. Possible values are:
* - "eventCreation" - Notification sent when a new event is put on the calendar.
* - "eventChange" - Notification sent when an event is changed.
* - "eventCancellation" - Notification sent when an event is cancelled.
* - "eventResponse" - Notification sent when an attendee responds to the event invitation.
* - "agenda" - An agenda with the events of the day (sent out in the morning).
* Required when adding a notification.
*/
type?: string | null;
}
export interface Schema$Channel {
/**
* The address where notifications are delivered for this channel.
*/
address?: string | null;
/**
* Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
*/
expiration?: string | null;
/**
* A UUID or similar unique string that identifies this channel.
*/
id?: string | null;
/**
* Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
*/
kind?: string | null;
/**
* Additional parameters controlling delivery channel behavior. Optional.
*/
params?: {[key: string]: string} | null;
/**
* A Boolean value to indicate whether payload is wanted. Optional.
*/
payload?: boolean | null;
/**
* An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
*/
resourceId?: string | null;
/**
* A version-specific identifier for the watched resource.
*/
resourceUri?: string | null;
/**
* An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
*/
token?: string | null;
/**
* 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 | null;
}
export interface Schema$ColorDefinition {
/**
* The background color associated with this color definition.
*/
background?: string | null;
/**
* The foreground color that can be used to write on top of a background with 'background' color.
*/
foreground?: string | null;
}
export interface Schema$Colors {
/**
* 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.
*/
calendar?: {[key: string]: Schema$ColorDefinition} | null;
/**
* 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.
*/
event?: {[key: string]: Schema$ColorDefinition} | null;
/**
* Type of the resource ("calendar#colors").
*/
kind?: string | null;
/**
* Last modification time of the color palette (as a RFC3339 timestamp). Read-only.
*/
updated?: string | null;
}
export interface Schema$ConferenceData {
/**
* The ID of the conference.
* Can be used by developers to keep track of conferences, should not be displayed to users.
* The ID value is formed differently for each conference solution type:
* - eventHangout: ID is not set. (This conference type is deprecated.)
* - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)
* - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
* - addOn: ID is defined by the third-party provider. Optional.
*/
conferenceId?: string | null;
/**
* 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.
*/
conferenceSolution?: Schema$ConferenceSolution;
/**
* 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.
*/
createRequest?: Schema$CreateConferenceRequest;
/**
* 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.
*/
entryPoints?: Schema$EntryPoint[];
/**
* 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.
*/
notes?: string | null;
/**
* Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
*/
parameters?: Schema$ConferenceParameters;
/**
* The signature of the conference data.
* Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
* Unset for a conference with a failed create request.
* Optional for a conference with a pending create request.
*/
signature?: string | null;
}
export interface Schema$ConferenceParameters {
/**
* Additional add-on specific data.
*/
addOnParameters?: Schema$ConferenceParametersAddOnParameters;
}
export interface Schema$ConferenceParametersAddOnParameters {
parameters?: {[key: string]: string} | null;
}
export interface Schema$ConferenceProperties {
/**
* The types of conference solutions that are supported for this calendar.
* The possible values are:
* - "eventHangout"
* - "eventNamedHangout"
* - "hangoutsMeet" Optional.
*/
allowedConferenceSolutionTypes?: string[] | null;
}
export interface Schema$ConferenceRequestStatus {
/**
* The current status of the conference create request. Read-only.
* The possible values are:
* - "pending": the conference create request is still being processed.
* - "success": the conference create request succeeded, the entry points are populated.
* - "failure": the conference create request failed, there are no entry points.
*/
statusCode?: string | null;
}
export interface Schema$ConferenceSolution {
/**
* The user-visible icon for this solution.
*/
iconUri?: string | null;
/**
* The key which can uniquely identify the conference solution for this event.
*/
key?: Schema$ConferenceSolutionKey;
/**
* The user-visible name of this solution. Not localized.
*/
name?: string | null;
}
export interface Schema$ConferenceSolutionKey {
/**
* The conference solution type.
* If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
* The possible values are:
* - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)
* - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)
* - "hangoutsMeet" for Google Meet (http://meet.google.com)
* - "addOn" for 3P conference providers
*/
type?: string | null;
}
export interface Schema$CreateConferenceRequest {
/**
* The conference solution, such as Hangouts or Google Meet.
*/
conferenceSolutionKey?: Schema$ConferenceSolutionKey;
/**
* 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.
*/
requestId?: string | null;
/**
* The status of the conference create request.
*/
status?: Schema$ConferenceRequestStatus;
}
export interface Schema$EntryPoint {
/**
* The access code 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.
* Optional.
*/
accessCode?: string | null;
/**
* 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.
*/
entryPointFeatures?: string[] | null;
/**
* The type of the conference entry point.
* Possible values are:
* - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
* - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
* - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
* - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
*/
entryPointType?: string | null;
/**
* The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
* Examples:
* - for video: meet.google.com/aaa-bbbb-ccc
* - for phone: +1 123 268 2601
* - for sip: 12345678@altostrat.com
* - for more: should not be filled
* Optional.
*/
label?: string | null;
/**
* The meeting code 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.
* Optional.
*/
meetingCode?: string | null;
/**
* 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.
*/
passcode?: string | null;
/**
* The password 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.
* Optional.
*/
password?: string | null;
/**
* The PIN 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.
* Optional.
*/
pin?: string | null;
/**
* 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.
*/
regionCode?: string | null;
/**
* The URI of the entry point. The maximum length is 1300 characters.
* Format:
* - for video, http: or https: schema is required.
* - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
* - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
* - for more, http: or https: schema is required.
*/
uri?: string | null;
}
export interface Schema$Error {
/**
* Domain, or broad category, of the error.
*/
domain?: string | null;
/**
* Specific reason for the error. Some of the possible values are:
* - "groupTooBig" - The group of users requested is too large for a single query.
* - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
* - "notFound" - The requested resource was not found.
* - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.
*/
reason?: string | null;
}
export interface Schema$Event {
/**
* Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.
*/
anyoneCanAddSelf?: boolean | null;
/**
* 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,
*/
attachments?: Schema$EventAttachment[];
/**
* 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.
*/
attendees?: Schema$EventAttendee[];
/**
* 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.
*/
attendeesOmitted?: boolean | null;
/**
* 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.
*/
colorId?: string | null;
/**
* 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.
*/
conferenceData?: Schema$ConferenceData;
/**
* Creation time of the event (as a RFC3339 timestamp). Read-only.
*/
created?: string | null;
/**
* The creator of the event. Read-only.
*/
creator?: {
displayName?: string;
email?: string;
id?: string;
self?: boolean;
} | null;
/**
* Description of the event. Can contain HTML. Optional.
*/
description?: string | null;
/**
* The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
*/
end?: Schema$EventDateTime;
/**
* 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.
*/
endTimeUnspecified?: boolean | null;
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* Specific type of the event. Read-only. Possible values are:
* - "default" - A regular event or not further specified.
* - "outOfOffice" - An out-of-office event.
*/
eventType?: string | null;
/**
* Extended properties of the event.
*/
extendedProperties?: {
private?: {[key: string]: string};
shared?: {[key: string]: string};
} | null;
/**
* A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
*/
gadget?: {
display?: string;
height?: number;
iconLink?: string;
link?: string;
preferences?: {[key: string]: string};
title?: string;
type?: string;
width?: number;
} | null;
/**
* Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
*/
guestsCanInviteOthers?: boolean | null;
/**
* Whether attendees other than the organizer can modify the event. Optional. The default is False.
*/
guestsCanModify?: boolean | null;
/**
* Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
*/
guestsCanSeeOtherGuests?: boolean | null;
/**
* An absolute link to the Google Hangout associated with this event. Read-only.
*/
hangoutLink?: string | null;
/**
* An absolute link to this event in the Google Calendar Web UI. Read-only.
*/
htmlLink?: string | null;
/**
* 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.
*/
iCalUID?: string | null;
/**
* Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
* - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
* - the length of the ID must be between 5 and 1024 characters
* - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
* If you do not specify an ID, it will be automatically generated by the server.
* Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
*/
id?: string | null;
/**
* Type of the resource ("calendar#event").
*/
kind?: string | null;
/**
* Geographic location of the event as free-form text. Optional.
*/
location?: string | null;
/**
* 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.
*/
locked?: boolean | null;
/**
* 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.
*/
organizer?: {
displayName?: string;
email?: string;
id?: string;
self?: boolean;
} | null;
/**
* 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.
*/
originalStartTime?: Schema$EventDateTime;
/**
* 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.
*/
privateCopy?: boolean | null;
/**
* List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
*/
recurrence?: string[] | null;
/**
* For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
*/
recurringEventId?: string | null;
/**
* Information about the event's reminders for the authenticated user.
*/
reminders?: {
overrides?: Schema$EventReminder[];
useDefault?: boolean;
} | null;
/**
* Sequence number as per iCalendar.
*/
sequence?: number | null;
/**
* 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.
*/
source?: {title?: string; url?: string} | null;
/**
* The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
*/
start?: Schema$EventDateTime;
/**
* Status of the event. Optional. Possible values are:
* - "confirmed" - The event is confirmed. This is the default status.
* - "tentative" - The event is tentatively confirmed.
* - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
* A cancelled status represents two different states depending on the event type:
* - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
* Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
* - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
* Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
* If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
*/
status?: string | null;
/**
* Title of the event.
*/
summary?: string | null;
/**
* Whether the event blocks time on the calendar. Optional. Possible values are:
* - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
* - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
*/
transparency?: string | null;
/**
* Last modification time of the event (as a RFC3339 timestamp). Read-only.
*/
updated?: string | null;
/**
* Visibility of the event. Optional. Possible values are:
* - "default" - Uses the default visibility for events on the calendar. This is the default value.
* - "public" - The event is public and event details are visible to all readers of the calendar.
* - "private" - The event is private and only event attendees may view event details.
* - "confidential" - The event is private. This value is provided for compatibility reasons.
*/
visibility?: string | null;
}
export interface Schema$EventAttachment {
/**
* 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.
*/
fileId?: string | null;
/**
* 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.
*/
fileUrl?: string | null;
/**
* URL link to the attachment's icon. Read-only.
*/
iconLink?: string | null;
/**
* Internet media type (MIME type) of the attachment.
*/
mimeType?: string | null;
/**
* Attachment title.
*/
title?: string | null;
}
export interface Schema$EventAttendee {
/**
* Number of additional guests. Optional. The default is 0.
*/
additionalGuests?: number | null;
/**
* The attendee's response comment. Optional.
*/
comment?: string | null;
/**
* The attendee's name, if available. Optional.
*/
displayName?: string | null;
/**
* 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.
*/
email?: string | null;
/**
* The attendee's Profile ID, if available.
*/
id?: string | null;
/**
* Whether this is an optional attendee. Optional. The default is False.
*/
optional?: boolean | null;
/**
* Whether the attendee is the organizer of the event. Read-only. The default is False.
*/
organizer?: boolean | null;
/**
* 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.
*/
resource?: boolean | null;
/**
* The attendee's response status. Possible values are:
* - "needsAction" - The attendee has not responded to the invitation.
* - "declined" - The attendee has declined the invitation.
* - "tentative" - The attendee has tentatively accepted the invitation.
* - "accepted" - The attendee has accepted the invitation.
*/
responseStatus?: string | null;
/**
* Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
*/
self?: boolean | null;
}
export interface Schema$EventDateTime {
/**
* The date, in the format "yyyy-mm-dd", if this is an all-day event.
*/
date?: string | null;
/**
* 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.
*/
dateTime?: string | null;
/**
* 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 a custom time zone for the event start/end.
*/
timeZone?: string | null;
}
export interface Schema$EventReminder {
/**
* The method used by this reminder. Possible values are:
* - "email" - Reminders are sent via email.
* - "popup" - Reminders are sent via a UI popup.
* Required when adding a reminder.
*/
method?: string | null;
/**
* 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.
*/
minutes?: number | null;
}
export interface Schema$Events {
/**
* The user's access role for this calendar. Read-only. Possible values are:
* - "none" - The user has no access.
* - "freeBusyReader" - The user has read access to free/busy information.
* - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
* - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
* - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
accessRole?: string | null;
/**
* 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).
*/
defaultReminders?: Schema$EventReminder[];
/**
* Description of the calendar. Read-only.
*/
description?: string | null;
/**
* ETag of the collection.
*/
etag?: string | null;
/**
* List of events on the calendar.
*/
items?: Schema$Event[];
/**
* Type of the collection ("calendar#events").
*/
kind?: string | null;
/**
* Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string | null;
/**
* 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.
*/
nextSyncToken?: string | null;
/**
* Title of the calendar. Read-only.
*/
summary?: string | null;
/**
* The time zone of the calendar. Read-only.
*/
timeZone?: string | null;
/**
* Last modification time of the calendar (as a RFC3339 timestamp). Read-only.
*/
updated?: string | null;
}
export interface Schema$FreeBusyCalendar {
/**
* List of time ranges during which this calendar should be regarded as busy.
*/
busy?: Schema$TimePeriod[];
/**
* Optional error(s) (if computation for the calendar failed).
*/
errors?: Schema$Error[];
}
export interface Schema$FreeBusyGroup {
/**
* List of calendars' identifiers within a group.
*/
calendars?: string[] | null;
/**
* Optional error(s) (if computation for the group failed).
*/
errors?: Schema$Error[];
}
export interface Schema$FreeBusyRequest {
/**
* Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
*/
calendarExpansionMax?: number | null;
/**
* 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.
*/
groupExpansionMax?: number | null;
/**
* List of calendars and/or groups to query.
*/
items?: Schema$FreeBusyRequestItem[];
/**
* The end of the interval for the query formatted as per RFC3339.
*/
timeMax?: string | null;
/**
* The start of the interval for the query formatted as per RFC3339.
*/
timeMin?: string | null;
/**
* Time zone used in the response. Optional. The default is UTC.
*/
timeZone?: string | null;
}
export interface Schema$FreeBusyRequestItem {
/**
* The identifier of a calendar or a group.
*/
id?: string | null;
}
export interface Schema$FreeBusyResponse {
/**
* List of free/busy information for calendars.
*/
calendars?: {[key: string]: Schema$FreeBusyCalendar} | null;
/**
* Expansion of groups.
*/
groups?: {[key: string]: Schema$FreeBusyGroup} | null;
/**
* Type of the resource ("calendar#freeBusy").
*/
kind?: string | null;
/**
* The end of the interval.
*/
timeMax?: string | null;
/**
* The start of the interval.
*/
timeMin?: string | null;
}
export interface Schema$Setting {
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* The id of the user setting.
*/
id?: string | null;
/**
* Type of the resource ("calendar#setting").
*/
kind?: string | null;
/**
* 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.
*/
value?: string | null;
}
export interface Schema$Settings {
/**
* Etag of the collection.
*/
etag?: string | null;
/**
* List of user settings.
*/
items?: Schema$Setting[];
/**
* Type of the collection ("calendar#settings").
*/
kind?: string | null;
/**
* Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string | null;
/**
* 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.
*/
nextSyncToken?: string | null;
}
export interface Schema$TimePeriod {
/**
* The (exclusive) end of the time period.
*/
end?: string | null;
/**
* The (inclusive) start of the time period.
*/
start?: string | null;
}
export class Resource$Acl {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Deletes an access control rule.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.acl.delete({
* // 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.
* calendarId: 'placeholder-value',
* // ACL rule identifier.
* ruleId: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Acl$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Acl$Delete,
options?: MethodOptions
): GaxiosPromise<void>;
delete(
params: Params$Resource$Acl$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
delete(
params: Params$Resource$Acl$Delete,
options: MethodOptions | BodyResponseCallback<void>,
callback: BodyResponseCallback<void>
): void;
delete(
params: Params$Resource$Acl$Delete,
callback: BodyResponseCallback<void>
): void;
delete(callback: BodyResponseCallback<void>): void;
delete(
paramsOrCallback?:
| Params$Resource$Acl$Delete
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Acl$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Acl$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/acl/{ruleId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE',
},
options
),
params,
requiredParams: ['calendarId', 'ruleId'],
pathParams: ['calendarId', 'ruleId'],
context: this.context,
};
if (callback) {
createAPIRequest<void>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<void>(parameters);
}
}
/**
* Returns an access control rule.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.acl.get({
* // 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.
* calendarId: 'placeholder-value',
* // ACL rule identifier.
* ruleId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "role": "my_role",
* // "scope": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Acl$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Acl$Get,
options?: MethodOptions
): GaxiosPromise<Schema$AclRule>;
get(
params: Params$Resource$Acl$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Acl$Get,
options: MethodOptions | BodyResponseCallback<Schema$AclRule>,
callback: BodyResponseCallback<Schema$AclRule>
): void;
get(
params: Params$Resource$Acl$Get,
callback: BodyResponseCallback<Schema$AclRule>
): void;
get(callback: BodyResponseCallback<Schema$AclRule>): void;
get(
paramsOrCallback?:
| Params$Resource$Acl$Get
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$AclRule> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Acl$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Acl$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/acl/{ruleId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['calendarId', 'ruleId'],
pathParams: ['calendarId', 'ruleId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$AclRule>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$AclRule>(parameters);
}
}
/**
* Creates an access control rule.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.acl.insert({
* // 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.
* calendarId: 'placeholder-value',
* // Whether to send notifications about the calendar sharing change. Optional. The default is True.
* sendNotifications: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "role": "my_role",
* // "scope": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "role": "my_role",
* // "scope": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
insert(
params: Params$Resource$Acl$Insert,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
insert(
params?: Params$Resource$Acl$Insert,
options?: MethodOptions
): GaxiosPromise<Schema$AclRule>;
insert(
params: Params$Resource$Acl$Insert,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
insert(
params: Params$Resource$Acl$Insert,
options: MethodOptions | BodyResponseCallback<Schema$AclRule>,
callback: BodyResponseCallback<Schema$AclRule>
): void;
insert(
params: Params$Resource$Acl$Insert,
callback: BodyResponseCallback<Schema$AclRule>
): void;
insert(callback: BodyResponseCallback<Schema$AclRule>): void;
insert(
paramsOrCallback?:
| Params$Resource$Acl$Insert
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$AclRule> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Acl$Insert;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Acl$Insert;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/calendars/{calendarId}/acl').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$AclRule>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$AclRule>(parameters);
}
}
/**
* Returns the rules in the access control list for the calendar.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.acl.list({
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* maxResults: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // 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.
* showDeleted: 'placeholder-value',
* // 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.
* // Learn more about incremental synchronization.
* // Optional. The default is to return all entries.
* syncToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "items": [],
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Acl$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Acl$List,
options?: MethodOptions
): GaxiosPromise<Schema$Acl>;
list(
params: Params$Resource$Acl$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Acl$List,
options: MethodOptions | BodyResponseCallback<Schema$Acl>,
callback: BodyResponseCallback<Schema$Acl>
): void;
list(
params: Params$Resource$Acl$List,
callback: BodyResponseCallback<Schema$Acl>
): void;
list(callback: BodyResponseCallback<Schema$Acl>): void;
list(
paramsOrCallback?:
| Params$Resource$Acl$List
| BodyResponseCallback<Schema$Acl>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Acl>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Acl>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Acl> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Acl$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Acl$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/calendars/{calendarId}/acl').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Acl>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Acl>(parameters);
}
}
/**
* Updates an access control rule. This method supports patch semantics.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.acl.patch({
* // 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.
* calendarId: 'placeholder-value',
* // ACL rule identifier.
* ruleId: 'placeholder-value',
* // Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
* sendNotifications: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "role": "my_role",
* // "scope": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "role": "my_role",
* // "scope": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(
params: Params$Resource$Acl$Patch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
patch(
params?: Params$Resource$Acl$Patch,
options?: MethodOptions
): GaxiosPromise<Schema$AclRule>;
patch(
params: Params$Resource$Acl$Patch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
patch(
params: Params$Resource$Acl$Patch,
options: MethodOptions | BodyResponseCallback<Schema$AclRule>,
callback: BodyResponseCallback<Schema$AclRule>
): void;
patch(
params: Params$Resource$Acl$Patch,
callback: BodyResponseCallback<Schema$AclRule>
): void;
patch(callback: BodyResponseCallback<Schema$AclRule>): void;
patch(
paramsOrCallback?:
| Params$Resource$Acl$Patch
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$AclRule> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Acl$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Acl$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/acl/{ruleId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH',
},
options
),
params,
requiredParams: ['calendarId', 'ruleId'],
pathParams: ['calendarId', 'ruleId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$AclRule>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$AclRule>(parameters);
}
}
/**
* Updates an access control rule.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.acl.update({
* // 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.
* calendarId: 'placeholder-value',
* // ACL rule identifier.
* ruleId: 'placeholder-value',
* // Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
* sendNotifications: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "role": "my_role",
* // "scope": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "role": "my_role",
* // "scope": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
update(
params: Params$Resource$Acl$Update,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
update(
params?: Params$Resource$Acl$Update,
options?: MethodOptions
): GaxiosPromise<Schema$AclRule>;
update(
params: Params$Resource$Acl$Update,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
update(
params: Params$Resource$Acl$Update,
options: MethodOptions | BodyResponseCallback<Schema$AclRule>,
callback: BodyResponseCallback<Schema$AclRule>
): void;
update(
params: Params$Resource$Acl$Update,
callback: BodyResponseCallback<Schema$AclRule>
): void;
update(callback: BodyResponseCallback<Schema$AclRule>): void;
update(
paramsOrCallback?:
| Params$Resource$Acl$Update
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$AclRule>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$AclRule> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Acl$Update;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Acl$Update;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/acl/{ruleId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'PUT',
},
options
),
params,
requiredParams: ['calendarId', 'ruleId'],
pathParams: ['calendarId', 'ruleId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$AclRule>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$AclRule>(parameters);
}
}
/**
* Watch for changes to ACL resources.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.acl.watch({
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* maxResults: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // 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.
* showDeleted: 'placeholder-value',
* // 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.
* // Learn more about incremental synchronization.
* // Optional. The default is to return all entries.
* syncToken: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
watch(
params: Params$Resource$Acl$Watch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
watch(
params?: Params$Resource$Acl$Watch,
options?: MethodOptions
): GaxiosPromise<Schema$Channel>;
watch(
params: Params$Resource$Acl$Watch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
watch(
params: Params$Resource$Acl$Watch,
options: MethodOptions | BodyResponseCallback<Schema$Channel>,
callback: BodyResponseCallback<Schema$Channel>
): void;
watch(
params: Params$Resource$Acl$Watch,
callback: BodyResponseCallback<Schema$Channel>
): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
watch(
paramsOrCallback?:
| Params$Resource$Acl$Watch
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Channel> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Acl$Watch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Acl$Watch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/acl/watch'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Channel>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Channel>(parameters);
}
}
}
export interface Params$Resource$Acl$Delete extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* ACL rule identifier.
*/
ruleId?: string;
}
export interface Params$Resource$Acl$Get extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* ACL rule identifier.
*/
ruleId?: string;
}
export interface Params$Resource$Acl$Insert extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* Whether to send notifications about the calendar sharing change. Optional. The default is True.
*/
sendNotifications?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$AclRule;
}
export interface Params$Resource$Acl$List extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* 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.
*/
maxResults?: number;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* 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.
*/
showDeleted?: boolean;
/**
* 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.
* Learn more about incremental synchronization.
* Optional. The default is to return all entries.
*/
syncToken?: string;
}
export interface Params$Resource$Acl$Patch extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* ACL rule identifier.
*/
ruleId?: string;
/**
* Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
*/
sendNotifications?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$AclRule;
}
export interface Params$Resource$Acl$Update extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* ACL rule identifier.
*/
ruleId?: string;
/**
* Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
*/
sendNotifications?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$AclRule;
}
export interface Params$Resource$Acl$Watch extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* 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.
*/
maxResults?: number;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* 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.
*/
showDeleted?: boolean;
/**
* 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.
* Learn more about incremental synchronization.
* Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Calendarlist {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Removes a calendar from the user's calendar list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendarList.delete({
* // 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.
* calendarId: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Calendarlist$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Calendarlist$Delete,
options?: MethodOptions
): GaxiosPromise<void>;
delete(
params: Params$Resource$Calendarlist$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
delete(
params: Params$Resource$Calendarlist$Delete,
options: MethodOptions | BodyResponseCallback<void>,
callback: BodyResponseCallback<void>
): void;
delete(
params: Params$Resource$Calendarlist$Delete,
callback: BodyResponseCallback<void>
): void;
delete(callback: BodyResponseCallback<void>): void;
delete(
paramsOrCallback?:
| Params$Resource$Calendarlist$Delete
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Calendarlist$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendarlist$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/users/me/calendarList/{calendarId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<void>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<void>(parameters);
}
}
/**
* Returns a calendar from the user's calendar list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendarList.get({
* // 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.
* calendarId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accessRole": "my_accessRole",
* // "backgroundColor": "my_backgroundColor",
* // "colorId": "my_colorId",
* // "conferenceProperties": {},
* // "defaultReminders": [],
* // "deleted": false,
* // "description": "my_description",
* // "etag": "my_etag",
* // "foregroundColor": "my_foregroundColor",
* // "hidden": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "notificationSettings": {},
* // "primary": false,
* // "selected": false,
* // "summary": "my_summary",
* // "summaryOverride": "my_summaryOverride",
* // "timeZone": "my_timeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Calendarlist$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Calendarlist$Get,
options?: MethodOptions
): GaxiosPromise<Schema$CalendarListEntry>;
get(
params: Params$Resource$Calendarlist$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Calendarlist$Get,
options: MethodOptions | BodyResponseCallback<Schema$CalendarListEntry>,
callback: BodyResponseCallback<Schema$CalendarListEntry>
): void;
get(
params: Params$Resource$Calendarlist$Get,
callback: BodyResponseCallback<Schema$CalendarListEntry>
): void;
get(callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
get(
paramsOrCallback?:
| Params$Resource$Calendarlist$Get
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$CalendarListEntry>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Calendarlist$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendarlist$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/users/me/calendarList/{calendarId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$CalendarListEntry>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$CalendarListEntry>(parameters);
}
}
/**
* Inserts an existing calendar into the user's calendar list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendarList.insert({
* // 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.
* colorRgbFormat: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "accessRole": "my_accessRole",
* // "backgroundColor": "my_backgroundColor",
* // "colorId": "my_colorId",
* // "conferenceProperties": {},
* // "defaultReminders": [],
* // "deleted": false,
* // "description": "my_description",
* // "etag": "my_etag",
* // "foregroundColor": "my_foregroundColor",
* // "hidden": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "notificationSettings": {},
* // "primary": false,
* // "selected": false,
* // "summary": "my_summary",
* // "summaryOverride": "my_summaryOverride",
* // "timeZone": "my_timeZone"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accessRole": "my_accessRole",
* // "backgroundColor": "my_backgroundColor",
* // "colorId": "my_colorId",
* // "conferenceProperties": {},
* // "defaultReminders": [],
* // "deleted": false,
* // "description": "my_description",
* // "etag": "my_etag",
* // "foregroundColor": "my_foregroundColor",
* // "hidden": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "notificationSettings": {},
* // "primary": false,
* // "selected": false,
* // "summary": "my_summary",
* // "summaryOverride": "my_summaryOverride",
* // "timeZone": "my_timeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
insert(
params: Params$Resource$Calendarlist$Insert,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
insert(
params?: Params$Resource$Calendarlist$Insert,
options?: MethodOptions
): GaxiosPromise<Schema$CalendarListEntry>;
insert(
params: Params$Resource$Calendarlist$Insert,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
insert(
params: Params$Resource$Calendarlist$Insert,
options: MethodOptions | BodyResponseCallback<Schema$CalendarListEntry>,
callback: BodyResponseCallback<Schema$CalendarListEntry>
): void;
insert(
params: Params$Resource$Calendarlist$Insert,
callback: BodyResponseCallback<Schema$CalendarListEntry>
): void;
insert(callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
insert(
paramsOrCallback?:
| Params$Resource$Calendarlist$Insert
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$CalendarListEntry>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Calendarlist$Insert;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendarlist$Insert;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/users/me/calendarList').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$CalendarListEntry>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$CalendarListEntry>(parameters);
}
}
/**
* Returns the calendars on the user's calendar list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendarList.list({
* // 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.
* maxResults: 'placeholder-value',
* // The minimum access role for the user in the returned entries. Optional. The default is no restriction.
* minAccessRole: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // Whether to include deleted calendar list entries in the result. Optional. The default is False.
* showDeleted: 'placeholder-value',
* // Whether to show hidden entries. Optional. The default is False.
* showHidden: 'placeholder-value',
* // 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.
* // 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.
* // Optional. The default is to return all entries.
* syncToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "items": [],
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Calendarlist$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Calendarlist$List,
options?: MethodOptions
): GaxiosPromise<Schema$CalendarList>;
list(
params: Params$Resource$Calendarlist$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Calendarlist$List,
options: MethodOptions | BodyResponseCallback<Schema$CalendarList>,
callback: BodyResponseCallback<Schema$CalendarList>
): void;
list(
params: Params$Resource$Calendarlist$List,
callback: BodyResponseCallback<Schema$CalendarList>
): void;
list(callback: BodyResponseCallback<Schema$CalendarList>): void;
list(
paramsOrCallback?:
| Params$Resource$Calendarlist$List
| BodyResponseCallback<Schema$CalendarList>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$CalendarList>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$CalendarList>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$CalendarList> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Calendarlist$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendarlist$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/users/me/calendarList').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$CalendarList>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$CalendarList>(parameters);
}
}
/**
* Updates an existing calendar on the user's calendar list. This method supports patch semantics.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendarList.patch({
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* colorRgbFormat: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "accessRole": "my_accessRole",
* // "backgroundColor": "my_backgroundColor",
* // "colorId": "my_colorId",
* // "conferenceProperties": {},
* // "defaultReminders": [],
* // "deleted": false,
* // "description": "my_description",
* // "etag": "my_etag",
* // "foregroundColor": "my_foregroundColor",
* // "hidden": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "notificationSettings": {},
* // "primary": false,
* // "selected": false,
* // "summary": "my_summary",
* // "summaryOverride": "my_summaryOverride",
* // "timeZone": "my_timeZone"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accessRole": "my_accessRole",
* // "backgroundColor": "my_backgroundColor",
* // "colorId": "my_colorId",
* // "conferenceProperties": {},
* // "defaultReminders": [],
* // "deleted": false,
* // "description": "my_description",
* // "etag": "my_etag",
* // "foregroundColor": "my_foregroundColor",
* // "hidden": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "notificationSettings": {},
* // "primary": false,
* // "selected": false,
* // "summary": "my_summary",
* // "summaryOverride": "my_summaryOverride",
* // "timeZone": "my_timeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(
params: Params$Resource$Calendarlist$Patch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
patch(
params?: Params$Resource$Calendarlist$Patch,
options?: MethodOptions
): GaxiosPromise<Schema$CalendarListEntry>;
patch(
params: Params$Resource$Calendarlist$Patch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
patch(
params: Params$Resource$Calendarlist$Patch,
options: MethodOptions | BodyResponseCallback<Schema$CalendarListEntry>,
callback: BodyResponseCallback<Schema$CalendarListEntry>
): void;
patch(
params: Params$Resource$Calendarlist$Patch,
callback: BodyResponseCallback<Schema$CalendarListEntry>
): void;
patch(callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
patch(
paramsOrCallback?:
| Params$Resource$Calendarlist$Patch
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$CalendarListEntry>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Calendarlist$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendarlist$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/users/me/calendarList/{calendarId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$CalendarListEntry>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$CalendarListEntry>(parameters);
}
}
/**
* Updates an existing calendar on the user's calendar list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendarList.update({
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* colorRgbFormat: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "accessRole": "my_accessRole",
* // "backgroundColor": "my_backgroundColor",
* // "colorId": "my_colorId",
* // "conferenceProperties": {},
* // "defaultReminders": [],
* // "deleted": false,
* // "description": "my_description",
* // "etag": "my_etag",
* // "foregroundColor": "my_foregroundColor",
* // "hidden": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "notificationSettings": {},
* // "primary": false,
* // "selected": false,
* // "summary": "my_summary",
* // "summaryOverride": "my_summaryOverride",
* // "timeZone": "my_timeZone"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accessRole": "my_accessRole",
* // "backgroundColor": "my_backgroundColor",
* // "colorId": "my_colorId",
* // "conferenceProperties": {},
* // "defaultReminders": [],
* // "deleted": false,
* // "description": "my_description",
* // "etag": "my_etag",
* // "foregroundColor": "my_foregroundColor",
* // "hidden": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "notificationSettings": {},
* // "primary": false,
* // "selected": false,
* // "summary": "my_summary",
* // "summaryOverride": "my_summaryOverride",
* // "timeZone": "my_timeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
update(
params: Params$Resource$Calendarlist$Update,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
update(
params?: Params$Resource$Calendarlist$Update,
options?: MethodOptions
): GaxiosPromise<Schema$CalendarListEntry>;
update(
params: Params$Resource$Calendarlist$Update,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
update(
params: Params$Resource$Calendarlist$Update,
options: MethodOptions | BodyResponseCallback<Schema$CalendarListEntry>,
callback: BodyResponseCallback<Schema$CalendarListEntry>
): void;
update(
params: Params$Resource$Calendarlist$Update,
callback: BodyResponseCallback<Schema$CalendarListEntry>
): void;
update(callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
update(
paramsOrCallback?:
| Params$Resource$Calendarlist$Update
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$CalendarListEntry>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$CalendarListEntry>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Calendarlist$Update;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendarlist$Update;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/users/me/calendarList/{calendarId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'PUT',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$CalendarListEntry>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$CalendarListEntry>(parameters);
}
}
/**
* Watch for changes to CalendarList resources.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendarList.watch({
* // 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.
* maxResults: 'placeholder-value',
* // The minimum access role for the user in the returned entries. Optional. The default is no restriction.
* minAccessRole: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // Whether to include deleted calendar list entries in the result. Optional. The default is False.
* showDeleted: 'placeholder-value',
* // Whether to show hidden entries. Optional. The default is False.
* showHidden: 'placeholder-value',
* // 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.
* // 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.
* // Optional. The default is to return all entries.
* syncToken: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
watch(
params: Params$Resource$Calendarlist$Watch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
watch(
params?: Params$Resource$Calendarlist$Watch,
options?: MethodOptions
): GaxiosPromise<Schema$Channel>;
watch(
params: Params$Resource$Calendarlist$Watch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
watch(
params: Params$Resource$Calendarlist$Watch,
options: MethodOptions | BodyResponseCallback<Schema$Channel>,
callback: BodyResponseCallback<Schema$Channel>
): void;
watch(
params: Params$Resource$Calendarlist$Watch,
callback: BodyResponseCallback<Schema$Channel>
): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
watch(
paramsOrCallback?:
| Params$Resource$Calendarlist$Watch
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Channel> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Calendarlist$Watch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendarlist$Watch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/users/me/calendarList/watch').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Channel>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Channel>(parameters);
}
}
}
export interface Params$Resource$Calendarlist$Delete
extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
}
export interface Params$Resource$Calendarlist$Get extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
}
export interface Params$Resource$Calendarlist$Insert
extends StandardParameters {
/**
* 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.
*/
colorRgbFormat?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$CalendarListEntry;
}
export interface Params$Resource$Calendarlist$List
extends StandardParameters {
/**
* 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.
*/
maxResults?: number;
/**
* The minimum access role for the user in the returned entries. Optional. The default is no restriction.
*/
minAccessRole?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Whether to include deleted calendar list entries in the result. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Whether to show hidden entries. Optional. The default is False.
*/
showHidden?: boolean;
/**
* 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.
* 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.
* Optional. The default is to return all entries.
*/
syncToken?: string;
}
export interface Params$Resource$Calendarlist$Patch
extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
*/
colorRgbFormat?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$CalendarListEntry;
}
export interface Params$Resource$Calendarlist$Update
extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
*/
colorRgbFormat?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$CalendarListEntry;
}
export interface Params$Resource$Calendarlist$Watch
extends StandardParameters {
/**
* 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.
*/
maxResults?: number;
/**
* The minimum access role for the user in the returned entries. Optional. The default is no restriction.
*/
minAccessRole?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Whether to include deleted calendar list entries in the result. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Whether to show hidden entries. Optional. The default is False.
*/
showHidden?: boolean;
/**
* 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.
* 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.
* Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Calendars {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendars.clear({
* // 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.
* calendarId: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
clear(
params: Params$Resource$Calendars$Clear,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
clear(
params?: Params$Resource$Calendars$Clear,
options?: MethodOptions
): GaxiosPromise<void>;
clear(
params: Params$Resource$Calendars$Clear,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
clear(
params: Params$Resource$Calendars$Clear,
options: MethodOptions | BodyResponseCallback<void>,
callback: BodyResponseCallback<void>
): void;
clear(
params: Params$Resource$Calendars$Clear,
callback: BodyResponseCallback<void>
): void;
clear(callback: BodyResponseCallback<void>): void;
clear(
paramsOrCallback?:
| Params$Resource$Calendars$Clear
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Calendars$Clear;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendars$Clear;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/clear'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<void>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<void>(parameters);
}
}
/**
* Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendars.delete({
* // 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.
* calendarId: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Calendars$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Calendars$Delete,
options?: MethodOptions
): GaxiosPromise<void>;
delete(
params: Params$Resource$Calendars$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
delete(
params: Params$Resource$Calendars$Delete,
options: MethodOptions | BodyResponseCallback<void>,
callback: BodyResponseCallback<void>
): void;
delete(
params: Params$Resource$Calendars$Delete,
callback: BodyResponseCallback<void>
): void;
delete(callback: BodyResponseCallback<void>): void;
delete(
paramsOrCallback?:
| Params$Resource$Calendars$Delete
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Calendars$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendars$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/calendars/{calendarId}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'DELETE',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<void>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<void>(parameters);
}
}
/**
* Returns metadata for a calendar.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendars.get({
* // 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.
* calendarId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "conferenceProperties": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Calendars$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Calendars$Get,
options?: MethodOptions
): GaxiosPromise<Schema$Calendar>;
get(
params: Params$Resource$Calendars$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Calendars$Get,
options: MethodOptions | BodyResponseCallback<Schema$Calendar>,
callback: BodyResponseCallback<Schema$Calendar>
): void;
get(
params: Params$Resource$Calendars$Get,
callback: BodyResponseCallback<Schema$Calendar>
): void;
get(callback: BodyResponseCallback<Schema$Calendar>): void;
get(
paramsOrCallback?:
| Params$Resource$Calendars$Get
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Calendar> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Calendars$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendars$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/calendars/{calendarId}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Calendar>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Calendar>(parameters);
}
}
/**
* Creates a secondary calendar.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendars.insert({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "conferenceProperties": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "conferenceProperties": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
insert(
params: Params$Resource$Calendars$Insert,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
insert(
params?: Params$Resource$Calendars$Insert,
options?: MethodOptions
): GaxiosPromise<Schema$Calendar>;
insert(
params: Params$Resource$Calendars$Insert,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
insert(
params: Params$Resource$Calendars$Insert,
options: MethodOptions | BodyResponseCallback<Schema$Calendar>,
callback: BodyResponseCallback<Schema$Calendar>
): void;
insert(
params: Params$Resource$Calendars$Insert,
callback: BodyResponseCallback<Schema$Calendar>
): void;
insert(callback: BodyResponseCallback<Schema$Calendar>): void;
insert(
paramsOrCallback?:
| Params$Resource$Calendars$Insert
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Calendar> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Calendars$Insert;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendars$Insert;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/calendars').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Calendar>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Calendar>(parameters);
}
}
/**
* Updates metadata for a calendar. This method supports patch semantics.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendars.patch({
* // 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.
* calendarId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "conferenceProperties": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "conferenceProperties": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(
params: Params$Resource$Calendars$Patch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
patch(
params?: Params$Resource$Calendars$Patch,
options?: MethodOptions
): GaxiosPromise<Schema$Calendar>;
patch(
params: Params$Resource$Calendars$Patch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
patch(
params: Params$Resource$Calendars$Patch,
options: MethodOptions | BodyResponseCallback<Schema$Calendar>,
callback: BodyResponseCallback<Schema$Calendar>
): void;
patch(
params: Params$Resource$Calendars$Patch,
callback: BodyResponseCallback<Schema$Calendar>
): void;
patch(callback: BodyResponseCallback<Schema$Calendar>): void;
patch(
paramsOrCallback?:
| Params$Resource$Calendars$Patch
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Calendar> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Calendars$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendars$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/calendars/{calendarId}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'PATCH',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Calendar>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Calendar>(parameters);
}
}
/**
* Updates metadata for a calendar.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/calendar'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.calendars.update({
* // 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.
* calendarId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "conferenceProperties": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "conferenceProperties": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
update(
params: Params$Resource$Calendars$Update,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
update(
params?: Params$Resource$Calendars$Update,
options?: MethodOptions
): GaxiosPromise<Schema$Calendar>;
update(
params: Params$Resource$Calendars$Update,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
update(
params: Params$Resource$Calendars$Update,
options: MethodOptions | BodyResponseCallback<Schema$Calendar>,
callback: BodyResponseCallback<Schema$Calendar>
): void;
update(
params: Params$Resource$Calendars$Update,
callback: BodyResponseCallback<Schema$Calendar>
): void;
update(callback: BodyResponseCallback<Schema$Calendar>): void;
update(
paramsOrCallback?:
| Params$Resource$Calendars$Update
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Calendar>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Calendar> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Calendars$Update;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Calendars$Update;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/calendars/{calendarId}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'PUT',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Calendar>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Calendar>(parameters);
}
}
}
export interface Params$Resource$Calendars$Clear extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
}
export interface Params$Resource$Calendars$Delete extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
}
export interface Params$Resource$Calendars$Get extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
}
export interface Params$Resource$Calendars$Insert extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$Calendar;
}
export interface Params$Resource$Calendars$Patch extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Calendar;
}
export interface Params$Resource$Calendars$Update extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Calendar;
}
export class Resource$Channels {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Stop watching resources through this channel
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* 'https://www.googleapis.com/auth/calendar.events.readonly',
* 'https://www.googleapis.com/auth/calendar.readonly',
* 'https://www.googleapis.com/auth/calendar.settings.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.channels.stop({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* },
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
stop(
params: Params$Resource$Channels$Stop,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
stop(
params?: Params$Resource$Channels$Stop,
options?: MethodOptions
): GaxiosPromise<void>;
stop(
params: Params$Resource$Channels$Stop,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
stop(
params: Params$Resource$Channels$Stop,
options: MethodOptions | BodyResponseCallback<void>,
callback: BodyResponseCallback<void>
): void;
stop(
params: Params$Resource$Channels$Stop,
callback: BodyResponseCallback<void>
): void;
stop(callback: BodyResponseCallback<void>): void;
stop(
paramsOrCallback?:
| Params$Resource$Channels$Stop
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Channels$Stop;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Channels$Stop;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/channels/stop').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<void>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<void>(parameters);
}
}
}
export interface Params$Resource$Channels$Stop extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Colors {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Returns the color definitions for calendars and events.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.colors.get({});
* console.log(res.data);
*
* // Example response
* // {
* // "calendar": {},
* // "event": {},
* // "kind": "my_kind",
* // "updated": "my_updated"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Colors$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Colors$Get,
options?: MethodOptions
): GaxiosPromise<Schema$Colors>;
get(
params: Params$Resource$Colors$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Colors$Get,
options: MethodOptions | BodyResponseCallback<Schema$Colors>,
callback: BodyResponseCallback<Schema$Colors>
): void;
get(
params: Params$Resource$Colors$Get,
callback: BodyResponseCallback<Schema$Colors>
): void;
get(callback: BodyResponseCallback<Schema$Colors>): void;
get(
paramsOrCallback?:
| Params$Resource$Colors$Get
| BodyResponseCallback<Schema$Colors>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Colors>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Colors>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Colors> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Colors$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Colors$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/colors').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Colors>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Colors>(parameters);
}
}
}
export interface Params$Resource$Colors$Get extends StandardParameters {}
export class Resource$Events {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Deletes an event.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.delete({
* // 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.
* calendarId: 'placeholder-value',
* // Event identifier.
* eventId: 'placeholder-value',
* // 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.
* sendNotifications: 'placeholder-value',
* // Guests who should receive notifications about the deletion of the event.
* sendUpdates: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Events$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Events$Delete,
options?: MethodOptions
): GaxiosPromise<void>;
delete(
params: Params$Resource$Events$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
delete(
params: Params$Resource$Events$Delete,
options: MethodOptions | BodyResponseCallback<void>,
callback: BodyResponseCallback<void>
): void;
delete(
params: Params$Resource$Events$Delete,
callback: BodyResponseCallback<void>
): void;
delete(callback: BodyResponseCallback<void>): void;
delete(
paramsOrCallback?:
| Params$Resource$Events$Delete
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<void>
| BodyResponseCallback<Readable>,
callback?: BodyResponseCallback<void> | BodyResponseCallback<Readable>
): void | GaxiosPromise<void> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events/{eventId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE',
},
options
),
params,
requiredParams: ['calendarId', 'eventId'],
pathParams: ['calendarId', 'eventId'],
context: this.context,
};
if (callback) {
createAPIRequest<void>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<void>(parameters);
}
}
/**
* Returns an event.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* 'https://www.googleapis.com/auth/calendar.events.readonly',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.get({
* // 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).
* alwaysIncludeEmail: 'placeholder-value',
* // 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.
* calendarId: 'placeholder-value',
* // Event identifier.
* eventId: 'placeholder-value',
* // 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.
* maxAttendees: 'placeholder-value',
* // Time zone used in the response. Optional. The default is the time zone of the calendar.
* timeZone: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Events$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Events$Get,
options?: MethodOptions
): GaxiosPromise<Schema$Event>;
get(
params: Params$Resource$Events$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Events$Get,
options: MethodOptions | BodyResponseCallback<Schema$Event>,
callback: BodyResponseCallback<Schema$Event>
): void;
get(
params: Params$Resource$Events$Get,
callback: BodyResponseCallback<Schema$Event>
): void;
get(callback: BodyResponseCallback<Schema$Event>): void;
get(
paramsOrCallback?:
| Params$Resource$Events$Get
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Event> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events/{eventId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['calendarId', 'eventId'],
pathParams: ['calendarId', 'eventId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Event>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Event>(parameters);
}
}
/**
* Imports an event. This operation is used to add a private copy of an existing event to a calendar.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.import({
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* conferenceDataVersion: 'placeholder-value',
* // Whether API client performing operation supports event attachments. Optional. The default is False.
* supportsAttachments: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
import(
params: Params$Resource$Events$Import,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
import(
params?: Params$Resource$Events$Import,
options?: MethodOptions
): GaxiosPromise<Schema$Event>;
import(
params: Params$Resource$Events$Import,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
import(
params: Params$Resource$Events$Import,
options: MethodOptions | BodyResponseCallback<Schema$Event>,
callback: BodyResponseCallback<Schema$Event>
): void;
import(
params: Params$Resource$Events$Import,
callback: BodyResponseCallback<Schema$Event>
): void;
import(callback: BodyResponseCallback<Schema$Event>): void;
import(
paramsOrCallback?:
| Params$Resource$Events$Import
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Event> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Import;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Import;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events/import'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Event>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Event>(parameters);
}
}
/**
* Creates an event.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.insert({
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* conferenceDataVersion: 'placeholder-value',
* // 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.
* maxAttendees: 'placeholder-value',
* // 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.
* sendNotifications: 'placeholder-value',
* // Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
* sendUpdates: 'placeholder-value',
* // Whether API client performing operation supports event attachments. Optional. The default is False.
* supportsAttachments: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
insert(
params: Params$Resource$Events$Insert,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
insert(
params?: Params$Resource$Events$Insert,
options?: MethodOptions
): GaxiosPromise<Schema$Event>;
insert(
params: Params$Resource$Events$Insert,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
insert(
params: Params$Resource$Events$Insert,
options: MethodOptions | BodyResponseCallback<Schema$Event>,
callback: BodyResponseCallback<Schema$Event>
): void;
insert(
params: Params$Resource$Events$Insert,
callback: BodyResponseCallback<Schema$Event>
): void;
insert(callback: BodyResponseCallback<Schema$Event>): void;
insert(
paramsOrCallback?:
| Params$Resource$Events$Insert
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Event> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Insert;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Insert;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Event>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Event>(parameters);
}
}
/**
* Returns instances of the specified recurring event.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* 'https://www.googleapis.com/auth/calendar.events.readonly',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.instances({
* // 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).
* alwaysIncludeEmail: 'placeholder-value',
* // 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.
* calendarId: 'placeholder-value',
* // Recurring event identifier.
* eventId: 'placeholder-value',
* // 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.
* maxAttendees: 'placeholder-value',
* // 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.
* maxResults: 'placeholder-value',
* // The original start time of the instance in the result. Optional.
* originalStart: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // 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.
* showDeleted: 'placeholder-value',
* // 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.
* timeMax: 'placeholder-value',
* // 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.
* timeMin: 'placeholder-value',
* // Time zone used in the response. Optional. The default is the time zone of the calendar.
* timeZone: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accessRole": "my_accessRole",
* // "defaultReminders": [],
* // "description": "my_description",
* // "etag": "my_etag",
* // "items": [],
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone",
* // "updated": "my_updated"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
instances(
params: Params$Resource$Events$Instances,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
instances(
params?: Params$Resource$Events$Instances,
options?: MethodOptions
): GaxiosPromise<Schema$Events>;
instances(
params: Params$Resource$Events$Instances,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
instances(
params: Params$Resource$Events$Instances,
options: MethodOptions | BodyResponseCallback<Schema$Events>,
callback: BodyResponseCallback<Schema$Events>
): void;
instances(
params: Params$Resource$Events$Instances,
callback: BodyResponseCallback<Schema$Events>
): void;
instances(callback: BodyResponseCallback<Schema$Events>): void;
instances(
paramsOrCallback?:
| Params$Resource$Events$Instances
| BodyResponseCallback<Schema$Events>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Events>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Events>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Events> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Instances;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Instances;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl +
'/calendar/v3/calendars/{calendarId}/events/{eventId}/instances'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['calendarId', 'eventId'],
pathParams: ['calendarId', 'eventId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Events>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Events>(parameters);
}
}
/**
* Returns events on the specified calendar.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* 'https://www.googleapis.com/auth/calendar.events.readonly',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.list({
* // 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).
* alwaysIncludeEmail: 'placeholder-value',
* // 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.
* calendarId: 'placeholder-value',
* // Specifies event ID in the iCalendar format to be included in the response. Optional.
* iCalUID: 'placeholder-value',
* // 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.
* maxAttendees: 'placeholder-value',
* // 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.
* maxResults: 'placeholder-value',
* // The order of the events returned in the result. Optional. The default is an unspecified, stable order.
* orderBy: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // 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.
* privateExtendedProperty: 'placeholder-value',
* // Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
* q: 'placeholder-value',
* // 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.
* sharedExtendedProperty: 'placeholder-value',
* // 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.
* showDeleted: 'placeholder-value',
* // Whether to include hidden invitations in the result. Optional. The default is False.
* showHiddenInvitations: 'placeholder-value',
* // 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.
* singleEvents: 'placeholder-value',
* // 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.
* // There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
* //
* // These are:
* // - iCalUID
* // - orderBy
* // - privateExtendedProperty
* // - q
* // - sharedExtendedProperty
* // - timeMin
* // - timeMax
* // - 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.
* // Learn more about incremental synchronization.
* // Optional. The default is to return all entries.
* syncToken: 'placeholder-value',
* // 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.
* timeMax: 'placeholder-value',
* // 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.
* timeMin: 'placeholder-value',
* // Time zone used in the response. Optional. The default is the time zone of the calendar.
* timeZone: 'placeholder-value',
* // 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.
* updatedMin: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accessRole": "my_accessRole",
* // "defaultReminders": [],
* // "description": "my_description",
* // "etag": "my_etag",
* // "items": [],
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken",
* // "summary": "my_summary",
* // "timeZone": "my_timeZone",
* // "updated": "my_updated"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Events$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Events$List,
options?: MethodOptions
): GaxiosPromise<Schema$Events>;
list(
params: Params$Resource$Events$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Events$List,
options: MethodOptions | BodyResponseCallback<Schema$Events>,
callback: BodyResponseCallback<Schema$Events>
): void;
list(
params: Params$Resource$Events$List,
callback: BodyResponseCallback<Schema$Events>
): void;
list(callback: BodyResponseCallback<Schema$Events>): void;
list(
paramsOrCallback?:
| Params$Resource$Events$List
| BodyResponseCallback<Schema$Events>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Events>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Events>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Events> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Events>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Events>(parameters);
}
}
/**
* Moves an event to another calendar, i.e. changes an event's organizer.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.move({
* // Calendar identifier of the source calendar where the event currently is on.
* calendarId: 'placeholder-value',
* // Calendar identifier of the target calendar where the event is to be moved to.
* destination: 'placeholder-value',
* // Event identifier.
* eventId: 'placeholder-value',
* // 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.
* sendNotifications: 'placeholder-value',
* // Guests who should receive notifications about the change of the event's organizer.
* sendUpdates: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
move(
params: Params$Resource$Events$Move,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
move(
params?: Params$Resource$Events$Move,
options?: MethodOptions
): GaxiosPromise<Schema$Event>;
move(
params: Params$Resource$Events$Move,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
move(
params: Params$Resource$Events$Move,
options: MethodOptions | BodyResponseCallback<Schema$Event>,
callback: BodyResponseCallback<Schema$Event>
): void;
move(
params: Params$Resource$Events$Move,
callback: BodyResponseCallback<Schema$Event>
): void;
move(callback: BodyResponseCallback<Schema$Event>): void;
move(
paramsOrCallback?:
| Params$Resource$Events$Move
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Event> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Move;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Move;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl +
'/calendar/v3/calendars/{calendarId}/events/{eventId}/move'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['calendarId', 'eventId', 'destination'],
pathParams: ['calendarId', 'eventId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Event>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Event>(parameters);
}
}
/**
* Updates an event. This method supports patch semantics.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.patch({
* // 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).
* alwaysIncludeEmail: 'placeholder-value',
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* conferenceDataVersion: 'placeholder-value',
* // Event identifier.
* eventId: 'placeholder-value',
* // 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.
* maxAttendees: 'placeholder-value',
* // 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.
* sendNotifications: 'placeholder-value',
* // Guests who should receive notifications about the event update (for example, title changes, etc.).
* sendUpdates: 'placeholder-value',
* // Whether API client performing operation supports event attachments. Optional. The default is False.
* supportsAttachments: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(
params: Params$Resource$Events$Patch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
patch(
params?: Params$Resource$Events$Patch,
options?: MethodOptions
): GaxiosPromise<Schema$Event>;
patch(
params: Params$Resource$Events$Patch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
patch(
params: Params$Resource$Events$Patch,
options: MethodOptions | BodyResponseCallback<Schema$Event>,
callback: BodyResponseCallback<Schema$Event>
): void;
patch(
params: Params$Resource$Events$Patch,
callback: BodyResponseCallback<Schema$Event>
): void;
patch(callback: BodyResponseCallback<Schema$Event>): void;
patch(
paramsOrCallback?:
| Params$Resource$Events$Patch
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Event> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events/{eventId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH',
},
options
),
params,
requiredParams: ['calendarId', 'eventId'],
pathParams: ['calendarId', 'eventId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Event>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Event>(parameters);
}
}
/**
* Creates an event based on a simple text string.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.quickAdd({
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* sendNotifications: 'placeholder-value',
* // Guests who should receive notifications about the creation of the new event.
* sendUpdates: 'placeholder-value',
* // The text describing the event to be created.
* text: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
quickAdd(
params: Params$Resource$Events$Quickadd,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
quickAdd(
params?: Params$Resource$Events$Quickadd,
options?: MethodOptions
): GaxiosPromise<Schema$Event>;
quickAdd(
params: Params$Resource$Events$Quickadd,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
quickAdd(
params: Params$Resource$Events$Quickadd,
options: MethodOptions | BodyResponseCallback<Schema$Event>,
callback: BodyResponseCallback<Schema$Event>
): void;
quickAdd(
params: Params$Resource$Events$Quickadd,
callback: BodyResponseCallback<Schema$Event>
): void;
quickAdd(callback: BodyResponseCallback<Schema$Event>): void;
quickAdd(
paramsOrCallback?:
| Params$Resource$Events$Quickadd
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Event> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Quickadd;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Quickadd;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events/quickAdd'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['calendarId', 'text'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Event>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Event>(parameters);
}
}
/**
* Updates an event.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.update({
* // 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).
* alwaysIncludeEmail: 'placeholder-value',
* // 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.
* calendarId: 'placeholder-value',
* // 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.
* conferenceDataVersion: 'placeholder-value',
* // Event identifier.
* eventId: 'placeholder-value',
* // 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.
* maxAttendees: 'placeholder-value',
* // 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.
* sendNotifications: 'placeholder-value',
* // Guests who should receive notifications about the event update (for example, title changes, etc.).
* sendUpdates: 'placeholder-value',
* // Whether API client performing operation supports event attachments. Optional. The default is False.
* supportsAttachments: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "anyoneCanAddSelf": false,
* // "attachments": [],
* // "attendees": [],
* // "attendeesOmitted": false,
* // "colorId": "my_colorId",
* // "conferenceData": {},
* // "created": "my_created",
* // "creator": {},
* // "description": "my_description",
* // "end": {},
* // "endTimeUnspecified": false,
* // "etag": "my_etag",
* // "eventType": "my_eventType",
* // "extendedProperties": {},
* // "gadget": {},
* // "guestsCanInviteOthers": false,
* // "guestsCanModify": false,
* // "guestsCanSeeOtherGuests": false,
* // "hangoutLink": "my_hangoutLink",
* // "htmlLink": "my_htmlLink",
* // "iCalUID": "my_iCalUID",
* // "id": "my_id",
* // "kind": "my_kind",
* // "location": "my_location",
* // "locked": false,
* // "organizer": {},
* // "originalStartTime": {},
* // "privateCopy": false,
* // "recurrence": [],
* // "recurringEventId": "my_recurringEventId",
* // "reminders": {},
* // "sequence": 0,
* // "source": {},
* // "start": {},
* // "status": "my_status",
* // "summary": "my_summary",
* // "transparency": "my_transparency",
* // "updated": "my_updated",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
update(
params: Params$Resource$Events$Update,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
update(
params?: Params$Resource$Events$Update,
options?: MethodOptions
): GaxiosPromise<Schema$Event>;
update(
params: Params$Resource$Events$Update,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
update(
params: Params$Resource$Events$Update,
options: MethodOptions | BodyResponseCallback<Schema$Event>,
callback: BodyResponseCallback<Schema$Event>
): void;
update(
params: Params$Resource$Events$Update,
callback: BodyResponseCallback<Schema$Event>
): void;
update(callback: BodyResponseCallback<Schema$Event>): void;
update(
paramsOrCallback?:
| Params$Resource$Events$Update
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Event>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Event> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Update;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Update;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events/{eventId}'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'PUT',
},
options
),
params,
requiredParams: ['calendarId', 'eventId'],
pathParams: ['calendarId', 'eventId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Event>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Event>(parameters);
}
}
/**
* Watch for changes to Events resources.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.events',
* 'https://www.googleapis.com/auth/calendar.events.readonly',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.events.watch({
* // 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).
* alwaysIncludeEmail: 'placeholder-value',
* // 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.
* calendarId: 'placeholder-value',
* // Specifies event ID in the iCalendar format to be included in the response. Optional.
* iCalUID: 'placeholder-value',
* // 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.
* maxAttendees: 'placeholder-value',
* // 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.
* maxResults: 'placeholder-value',
* // The order of the events returned in the result. Optional. The default is an unspecified, stable order.
* orderBy: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // 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.
* privateExtendedProperty: 'placeholder-value',
* // Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
* q: 'placeholder-value',
* // 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.
* sharedExtendedProperty: 'placeholder-value',
* // 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.
* showDeleted: 'placeholder-value',
* // Whether to include hidden invitations in the result. Optional. The default is False.
* showHiddenInvitations: 'placeholder-value',
* // 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.
* singleEvents: 'placeholder-value',
* // 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.
* // There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
* //
* // These are:
* // - iCalUID
* // - orderBy
* // - privateExtendedProperty
* // - q
* // - sharedExtendedProperty
* // - timeMin
* // - timeMax
* // - 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.
* // Learn more about incremental synchronization.
* // Optional. The default is to return all entries.
* syncToken: 'placeholder-value',
* // 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.
* timeMax: 'placeholder-value',
* // 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.
* timeMin: 'placeholder-value',
* // Time zone used in the response. Optional. The default is the time zone of the calendar.
* timeZone: 'placeholder-value',
* // 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.
* updatedMin: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
watch(
params: Params$Resource$Events$Watch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
watch(
params?: Params$Resource$Events$Watch,
options?: MethodOptions
): GaxiosPromise<Schema$Channel>;
watch(
params: Params$Resource$Events$Watch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
watch(
params: Params$Resource$Events$Watch,
options: MethodOptions | BodyResponseCallback<Schema$Channel>,
callback: BodyResponseCallback<Schema$Channel>
): void;
watch(
params: Params$Resource$Events$Watch,
callback: BodyResponseCallback<Schema$Channel>
): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
watch(
paramsOrCallback?:
| Params$Resource$Events$Watch
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Channel> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Events$Watch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Events$Watch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/calendar/v3/calendars/{calendarId}/events/watch'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['calendarId'],
pathParams: ['calendarId'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Channel>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Channel>(parameters);
}
}
}
export interface Params$Resource$Events$Delete extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* Event identifier.
*/
eventId?: string;
/**
* 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.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the deletion of the event.
*/
sendUpdates?: string;
}
export interface Params$Resource$Events$Get extends StandardParameters {
/**
* 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).
*/
alwaysIncludeEmail?: boolean;
/**
* 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.
*/
calendarId?: string;
/**
* Event identifier.
*/
eventId?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
}
export interface Params$Resource$Events$Import extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
* Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Event;
}
export interface Params$Resource$Events$Insert extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
* 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.
*/
maxAttendees?: number;
/**
* 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.
*/
sendNotifications?: boolean;
/**
* Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
*/
sendUpdates?: string;
/**
* Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Event;
}
export interface Params$Resource$Events$Instances extends StandardParameters {
/**
* 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).
*/
alwaysIncludeEmail?: boolean;
/**
* 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.
*/
calendarId?: string;
/**
* Recurring event identifier.
*/
eventId?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* 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.
*/
maxResults?: number;
/**
* The original start time of the instance in the result. Optional.
*/
originalStart?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* 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.
*/
showDeleted?: boolean;
/**
* 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.
*/
timeMax?: string;
/**
* 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.
*/
timeMin?: string;
/**
* Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
}
export interface Params$Resource$Events$List extends StandardParameters {
/**
* 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).
*/
alwaysIncludeEmail?: boolean;
/**
* 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.
*/
calendarId?: string;
/**
* Specifies event ID in the iCalendar format to be included in the response. Optional.
*/
iCalUID?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* 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.
*/
maxResults?: number;
/**
* The order of the events returned in the result. Optional. The default is an unspecified, stable order.
*/
orderBy?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* 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.
*/
privateExtendedProperty?: string[];
/**
* Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
*/
q?: string;
/**
* 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.
*/
sharedExtendedProperty?: string[];
/**
* 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.
*/
showDeleted?: boolean;
/**
* Whether to include hidden invitations in the result. Optional. The default is False.
*/
showHiddenInvitations?: boolean;
/**
* 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.
*/
singleEvents?: boolean;
/**
* 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.
* There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
*
* These are:
* - iCalUID
* - orderBy
* - privateExtendedProperty
* - q
* - sharedExtendedProperty
* - timeMin
* - timeMax
* - 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.
* Learn more about incremental synchronization.
* Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* 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.
*/
timeMax?: string;
/**
* 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.
*/
timeMin?: string;
/**
* Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
/**
* 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.
*/
updatedMin?: string;
}
export interface Params$Resource$Events$Move extends StandardParameters {
/**
* Calendar identifier of the source calendar where the event currently is on.
*/
calendarId?: string;
/**
* Calendar identifier of the target calendar where the event is to be moved to.
*/
destination?: string;
/**
* Event identifier.
*/
eventId?: string;
/**
* 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.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the change of the event's organizer.
*/
sendUpdates?: string;
}
export interface Params$Resource$Events$Patch extends StandardParameters {
/**
* 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).
*/
alwaysIncludeEmail?: boolean;
/**
* 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.
*/
calendarId?: string;
/**
* Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
* Event identifier.
*/
eventId?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* 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.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the event update (for example, title changes, etc.).
*/
sendUpdates?: string;
/**
* Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Event;
}
export interface Params$Resource$Events$Quickadd extends StandardParameters {
/**
* 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.
*/
calendarId?: string;
/**
* 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.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the creation of the new event.
*/
sendUpdates?: string;
/**
* The text describing the event to be created.
*/
text?: string;
}
export interface Params$Resource$Events$Update extends StandardParameters {
/**
* 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).
*/
alwaysIncludeEmail?: boolean;
/**
* 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.
*/
calendarId?: string;
/**
* Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
* Event identifier.
*/
eventId?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* 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.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the event update (for example, title changes, etc.).
*/
sendUpdates?: string;
/**
* Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Event;
}
export interface Params$Resource$Events$Watch extends StandardParameters {
/**
* 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).
*/
alwaysIncludeEmail?: boolean;
/**
* 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.
*/
calendarId?: string;
/**
* Specifies event ID in the iCalendar format to be included in the response. Optional.
*/
iCalUID?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* 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.
*/
maxResults?: number;
/**
* The order of the events returned in the result. Optional. The default is an unspecified, stable order.
*/
orderBy?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* 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.
*/
privateExtendedProperty?: string[];
/**
* Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
*/
q?: string;
/**
* 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.
*/
sharedExtendedProperty?: string[];
/**
* 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.
*/
showDeleted?: boolean;
/**
* Whether to include hidden invitations in the result. Optional. The default is False.
*/
showHiddenInvitations?: boolean;
/**
* 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.
*/
singleEvents?: boolean;
/**
* 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.
* There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
*
* These are:
* - iCalUID
* - orderBy
* - privateExtendedProperty
* - q
* - sharedExtendedProperty
* - timeMin
* - timeMax
* - 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.
* Learn more about incremental synchronization.
* Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* 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.
*/
timeMax?: string;
/**
* 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.
*/
timeMin?: string;
/**
* Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
/**
* 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.
*/
updatedMin?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Freebusy {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Returns free/busy information for a set of calendars.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.freebusy.query({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "calendarExpansionMax": 0,
* // "groupExpansionMax": 0,
* // "items": [],
* // "timeMax": "my_timeMax",
* // "timeMin": "my_timeMin",
* // "timeZone": "my_timeZone"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "calendars": {},
* // "groups": {},
* // "kind": "my_kind",
* // "timeMax": "my_timeMax",
* // "timeMin": "my_timeMin"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
query(
params: Params$Resource$Freebusy$Query,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
query(
params?: Params$Resource$Freebusy$Query,
options?: MethodOptions
): GaxiosPromise<Schema$FreeBusyResponse>;
query(
params: Params$Resource$Freebusy$Query,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
query(
params: Params$Resource$Freebusy$Query,
options: MethodOptions | BodyResponseCallback<Schema$FreeBusyResponse>,
callback: BodyResponseCallback<Schema$FreeBusyResponse>
): void;
query(
params: Params$Resource$Freebusy$Query,
callback: BodyResponseCallback<Schema$FreeBusyResponse>
): void;
query(callback: BodyResponseCallback<Schema$FreeBusyResponse>): void;
query(
paramsOrCallback?:
| Params$Resource$Freebusy$Query
| BodyResponseCallback<Schema$FreeBusyResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$FreeBusyResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$FreeBusyResponse>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$FreeBusyResponse> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Freebusy$Query;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Freebusy$Query;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/freeBusy').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$FreeBusyResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$FreeBusyResponse>(parameters);
}
}
}
export interface Params$Resource$Freebusy$Query extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$FreeBusyRequest;
}
export class Resource$Settings {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Returns a single user setting.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* 'https://www.googleapis.com/auth/calendar.settings.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.settings.get({
* // The id of the user setting.
* setting: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "id": "my_id",
* // "kind": "my_kind",
* // "value": "my_value"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Settings$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Settings$Get,
options?: MethodOptions
): GaxiosPromise<Schema$Setting>;
get(
params: Params$Resource$Settings$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Settings$Get,
options: MethodOptions | BodyResponseCallback<Schema$Setting>,
callback: BodyResponseCallback<Schema$Setting>
): void;
get(
params: Params$Resource$Settings$Get,
callback: BodyResponseCallback<Schema$Setting>
): void;
get(callback: BodyResponseCallback<Schema$Setting>): void;
get(
paramsOrCallback?:
| Params$Resource$Settings$Get
| BodyResponseCallback<Schema$Setting>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Setting>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Setting>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Setting> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Settings$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Settings$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/users/me/settings/{setting}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['setting'],
pathParams: ['setting'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Setting>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Setting>(parameters);
}
}
/**
* Returns all user settings for the authenticated user.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* 'https://www.googleapis.com/auth/calendar.settings.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.settings.list({
* // 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.
* maxResults: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // 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.
* // Learn more about incremental synchronization.
* // Optional. The default is to return all entries.
* syncToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "items": [],
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Settings$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Settings$List,
options?: MethodOptions
): GaxiosPromise<Schema$Settings>;
list(
params: Params$Resource$Settings$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Settings$List,
options: MethodOptions | BodyResponseCallback<Schema$Settings>,
callback: BodyResponseCallback<Schema$Settings>
): void;
list(
params: Params$Resource$Settings$List,
callback: BodyResponseCallback<Schema$Settings>
): void;
list(callback: BodyResponseCallback<Schema$Settings>): void;
list(
paramsOrCallback?:
| Params$Resource$Settings$List
| BodyResponseCallback<Schema$Settings>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Settings>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Settings>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Settings> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Settings$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Settings$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/users/me/settings').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Settings>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Settings>(parameters);
}
}
/**
* Watch for changes to Settings resources.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/calendar.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/calendar',
* 'https://www.googleapis.com/auth/calendar.readonly',
* 'https://www.googleapis.com/auth/calendar.settings.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await calendar.settings.watch({
* // 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.
* maxResults: 'placeholder-value',
* // Token specifying which result page to return. Optional.
* pageToken: 'placeholder-value',
* // 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.
* // Learn more about incremental synchronization.
* // Optional. The default is to return all entries.
* syncToken: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "address": "my_address",
* // "expiration": "my_expiration",
* // "id": "my_id",
* // "kind": "my_kind",
* // "params": {},
* // "payload": false,
* // "resourceId": "my_resourceId",
* // "resourceUri": "my_resourceUri",
* // "token": "my_token",
* // "type": "my_type"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
watch(
params: Params$Resource$Settings$Watch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
watch(
params?: Params$Resource$Settings$Watch,
options?: MethodOptions
): GaxiosPromise<Schema$Channel>;
watch(
params: Params$Resource$Settings$Watch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
watch(
params: Params$Resource$Settings$Watch,
options: MethodOptions | BodyResponseCallback<Schema$Channel>,
callback: BodyResponseCallback<Schema$Channel>
): void;
watch(
params: Params$Resource$Settings$Watch,
callback: BodyResponseCallback<Schema$Channel>
): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
watch(
paramsOrCallback?:
| Params$Resource$Settings$Watch
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Channel>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Channel> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Settings$Watch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Settings$Watch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/calendar/v3/users/me/settings/watch').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Channel>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Channel>(parameters);
}
}
}
export interface Params$Resource$Settings$Get extends StandardParameters {
/**
* The id of the user setting.
*/
setting?: string;
}
export interface Params$Resource$Settings$List extends StandardParameters {
/**
* 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.
*/
maxResults?: number;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* 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.
* Learn more about incremental synchronization.
* Optional. The default is to return all entries.
*/
syncToken?: string;
}
export interface Params$Resource$Settings$Watch extends StandardParameters {
/**
* 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.
*/
maxResults?: number;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* 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.
* Learn more about incremental synchronization.
* Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
}