google_api_calendar v0.13.0 API Reference

API calls for all endpoints tagged Acl.

API calls for all endpoints tagged CalendarList.

API calls for all endpoints tagged Calendars.

API calls for all endpoints tagged Channels.

API calls for all endpoints tagged Colors.

API calls for all endpoints tagged Events.

API calls for all endpoints tagged Freebusy.

API calls for all endpoints tagged Settings.

Handle Tesla connections for GoogleApi.Calendar.V3.

Attributes

• etag (type: String.t, default: nil) - ETag of the collection.
• items (type: list(GoogleApi.Calendar.V3.Model.AclRule.t), default: nil) - List of rules on the access control list.
• kind (type: String.t, default: calendar#acl) - Type of the collection ("calendar#acl").
• nextPageToken (type: String.t, default: nil) - Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
• nextSyncToken (type: String.t, default: nil) - 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.

Attributes

• etag (type: String.t, default: nil) - ETag of the resource.
• id (type: String.t, default: nil) - Identifier of the ACL rule.
• kind (type: String.t, default: calendar#aclRule) - Type of the resource ("calendar#aclRule").

• role (type: String.t, default: nil) - The role assigned to the scope. Possible values are:

The scope of the rule.

Attributes

• conferenceProperties (type: GoogleApi.Calendar.V3.Model.ConferenceProperties.t, default: nil) - Conferencing properties for this calendar, for example what types of conferences are allowed.
• description (type: String.t, default: nil) - Description of the calendar. Optional.
• etag (type: String.t, default: nil) - ETag of the resource.
• id (type: String.t, default: nil) - Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
• kind (type: String.t, default: calendar#calendar) - Type of the resource ("calendar#calendar").
• location (type: String.t, default: nil) - Geographic location of the calendar as free-form text. Optional.
• summary (type: String.t, default: nil) - Title of the calendar.
• timeZone (type: String.t, default: nil) - The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

Attributes

• etag (type: String.t, default: nil) - ETag of the collection.
• items (type: list(GoogleApi.Calendar.V3.Model.CalendarListEntry.t), default: nil) - Calendars that are present on the user's calendar list.
• kind (type: String.t, default: calendar#calendarList) - Type of the collection ("calendar#calendarList").
• nextPageToken (type: String.t, default: nil) - Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
• nextSyncToken (type: String.t, default: nil) - 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.

Attributes

• accessRole (type: String.t, default: nil) - The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:

The notifications that the authenticated user is receiving for this calendar.

Attributes

• method (type: String.t, default: nil) - The method used to deliver the notification. Possible values are:

Attributes

• address (type: String.t, default: nil) - The address where notifications are delivered for this channel.
• expiration (type: String.t, default: nil) - Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
• id (type: String.t, default: nil) - A UUID or similar unique string that identifies this channel.
• kind (type: String.t, default: api#channel) - Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
• params (type: map(), default: nil) - Additional parameters controlling delivery channel behavior. Optional.
• payload (type: boolean(), default: nil) - A Boolean value to indicate whether payload is wanted. Optional.
• resourceId (type: String.t, default: nil) - An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
• resourceUri (type: String.t, default: nil) - A version-specific identifier for the watched resource.
• token (type: String.t, default: nil) - An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
• type (type: String.t, default: nil) - The type of delivery mechanism used for this channel.

Attributes

• background (type: String.t, default: nil) - The background color associated with this color definition.
• foreground (type: String.t, default: nil) - The foreground color that can be used to write on top of a background with 'background' color.

Attributes

• calendar (type: %{optional(String.t) => GoogleApi.Calendar.V3.Model.ColorDefinition.t}, default: nil) - 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 color field. Read-only.
• event (type: %{optional(String.t) => GoogleApi.Calendar.V3.Model.ColorDefinition.t}, default: nil) - 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 color field. Read-only.
• kind (type: String.t, default: calendar#colors) - Type of the resource ("calendar#colors").
• updated (type: DateTime.t, default: nil) - Last modification time of the color palette (as a RFC3339 timestamp). Read-only.

Attributes

• conferenceId (type: String.t, default: nil) - The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types:

Attributes

• addOnParameters (type: GoogleApi.Calendar.V3.Model.ConferenceParametersAddOnParameters.t, default: nil) - Additional add-on specific data.

Attributes

• parameters (type: map(), default: nil) -

Attributes

• allowedConferenceSolutionTypes (type: list(String.t), default: nil) - The types of conference solutions that are supported for this calendar. The possible values are:

Attributes

• statusCode (type: String.t, default: nil) - The current status of the conference create request. Read-only. The possible values are:

Attributes

• iconUri (type: String.t, default: nil) - The user-visible icon for this solution.
• key (type: GoogleApi.Calendar.V3.Model.ConferenceSolutionKey.t, default: nil) - The key which can uniquely identify the conference solution for this event.
• name (type: String.t, default: nil) - The user-visible name of this solution. Not localized.

Attributes

• type (type: String.t, default: nil) - 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:

Attributes

• conferenceSolutionKey (type: GoogleApi.Calendar.V3.Model.ConferenceSolutionKey.t, default: nil) - The conference solution, such as Hangouts or Hangouts Meet.
• requestId (type: String.t, default: nil) - 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.
• status (type: GoogleApi.Calendar.V3.Model.ConferenceRequestStatus.t, default: nil) - The status of the conference create request.

Attributes

• accessCode (type: String.t, default: nil) - 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.
• entryPointFeatures (type: list(String.t), default: nil) - 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.

• entryPointType (type: String.t, default: nil) - The type of the conference entry point. Possible values are:

Attributes

• domain (type: String.t, default: nil) - Domain, or broad category, of the error.

• reason (type: String.t, default: nil) - Specific reason for the error. Some of the possible values are:

Attributes

• etag (type: String.t, default: nil) - ETag of the resource.
• attendeesOmitted (type: boolean(), default: false) - 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.
• reminders (type: GoogleApi.Calendar.V3.Model.EventReminders.t, default: nil) - Information about the event's reminders for the authenticated user.
• guestsCanSeeOtherGuests (type: boolean(), default: true) - Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
• summary (type: String.t, default: nil) - Title of the event.
• privateCopy (type: boolean(), default: false) - 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.
• conferenceData (type: GoogleApi.Calendar.V3.Model.ConferenceData.t, default: nil) - The conference-related information, such as details of a Hangouts 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.
• hangoutLink (type: String.t, default: nil) - An absolute link to the Google+ hangout associated with this event. Read-only.
• attachments (type: list(GoogleApi.Calendar.V3.Model.EventAttachment.t), default: nil) - 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,
• description (type: String.t, default: nil) - Description of the event. Can contain HTML. Optional.
• kind (type: String.t, default: calendar#event) - Type of the resource ("calendar#event").
• guestsCanModify (type: boolean(), default: false) - Whether attendees other than the organizer can modify the event. Optional. The default is False.
• attendees (type: list(GoogleApi.Calendar.V3.Model.EventAttendee.t), default: nil) - The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
• start (type: GoogleApi.Calendar.V3.Model.EventDateTime.t, default: nil) - The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
• creator (type: GoogleApi.Calendar.V3.Model.EventCreator.t, default: nil) - The creator of the event. Read-only.
• anyoneCanAddSelf (type: boolean(), default: false) - Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
• organizer (type: GoogleApi.Calendar.V3.Model.EventOrganizer.t, default: nil) - 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.
• location (type: String.t, default: nil) - Geographic location of the event as free-form text. Optional.

• status (type: String.t, default: nil) - Status of the event. Optional. Possible values are:

Attributes

• fileId (type: String.t, default: nil) - 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.
• fileUrl (type: String.t, default: nil) - 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.
• iconLink (type: String.t, default: nil) - URL link to the attachment's icon. Read-only.
• mimeType (type: String.t, default: nil) - Internet media type (MIME type) of the attachment.
• title (type: String.t, default: nil) - Attachment title.

Attributes

• additionalGuests (type: integer(), default: 0) - Number of additional guests. Optional. The default is 0.
• comment (type: String.t, default: nil) - The attendee's response comment. Optional.
• displayName (type: String.t, default: nil) - The attendee's name, if available. Optional.
• email (type: String.t, default: nil) - 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.
• id (type: String.t, default: nil) - The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
• optional (type: boolean(), default: false) - Whether this is an optional attendee. Optional. The default is False.
• organizer (type: boolean(), default: nil) - Whether the attendee is the organizer of the event. Read-only. The default is False.
• resource (type: boolean(), default: false) - 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.

• responseStatus (type: String.t, default: nil) - The attendee's response status. Possible values are:

The creator of the event. Read-only.

Attributes

• date (type: Date.t, default: nil) - The date, in the format "yyyy-mm-dd", if this is an all-day event.
• dateTime (type: DateTime.t, default: nil) - 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.
• timeZone (type: String.t, default: nil) - 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.

Extended properties of the event.

A gadget that extends this event.

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.

Attributes

• method (type: String.t, default: nil) - The method used by this reminder. Possible values are:

Information about the event's reminders for the authenticated user.

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.

Attributes

• accessRole (type: String.t, default: nil) - The user's access role for this calendar. Read-only. Possible values are:

Attributes

• busy (type: list(GoogleApi.Calendar.V3.Model.TimePeriod.t), default: nil) - List of time ranges during which this calendar should be regarded as busy.
• errors (type: list(GoogleApi.Calendar.V3.Model.Error.t), default: nil) - Optional error(s) (if computation for the calendar failed).

Attributes

• calendars (type: list(String.t), default: nil) - List of calendars' identifiers within a group.
• errors (type: list(GoogleApi.Calendar.V3.Model.Error.t), default: nil) - Optional error(s) (if computation for the group failed).

Attributes

• calendarExpansionMax (type: integer(), default: nil) - Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
• groupExpansionMax (type: integer(), default: nil) - 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.
• items (type: list(GoogleApi.Calendar.V3.Model.FreeBusyRequestItem.t), default: nil) - List of calendars and/or groups to query.
• timeMax (type: DateTime.t, default: nil) - The end of the interval for the query formatted as per RFC3339.
• timeMin (type: DateTime.t, default: nil) - The start of the interval for the query formatted as per RFC3339.
• timeZone (type: String.t, default: UTC) - Time zone used in the response. Optional. The default is UTC.

Attributes

• id (type: String.t, default: nil) - The identifier of a calendar or a group.

Attributes

• calendars (type: %{optional(String.t) => GoogleApi.Calendar.V3.Model.FreeBusyCalendar.t}, default: nil) - List of free/busy information for calendars.
• groups (type: %{optional(String.t) => GoogleApi.Calendar.V3.Model.FreeBusyGroup.t}, default: nil) - Expansion of groups.
• kind (type: String.t, default: calendar#freeBusy) - Type of the resource ("calendar#freeBusy").
• timeMax (type: DateTime.t, default: nil) - The end of the interval.
• timeMin (type: DateTime.t, default: nil) - The start of the interval.

Attributes

• etag (type: String.t, default: nil) - ETag of the resource.
• id (type: String.t, default: nil) - The id of the user setting.
• kind (type: String.t, default: calendar#setting) - Type of the resource ("calendar#setting").
• value (type: String.t, default: nil) - 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.

Attributes

• etag (type: String.t, default: nil) - Etag of the collection.
• items (type: list(GoogleApi.Calendar.V3.Model.Setting.t), default: nil) - List of user settings.
• kind (type: String.t, default: calendar#settings) - Type of the collection ("calendar#settings").
• nextPageToken (type: String.t, default: nil) - Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
• nextSyncToken (type: String.t, default: nil) - 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.

Attributes

• end (type: DateTime.t, default: nil) - The (exclusive) end of the time period.
• start (type: DateTime.t, default: nil) - The (inclusive) start of the time period.