gogol-apps-calendar-0.0.1: Google Calendar SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.AppsCalendar

Contents

Description

Lets you manipulate events and other calendar data.

See: Calendar API Reference

Synopsis

Service Configuration

appsCalendarService :: Service Source

Default request referring to version v3 of the Calendar API. This contains the host and root path used as a starting point for constructing service requests.

API Declaration

Resources

calendar.acl.delete

calendar.acl.get

calendar.acl.insert

calendar.acl.list

calendar.acl.patch

calendar.acl.update

calendar.acl.watch

calendar.calendarList.delete

calendar.calendarList.get

calendar.calendarList.insert

calendar.calendarList.list

calendar.calendarList.patch

calendar.calendarList.update

calendar.calendarList.watch

calendar.calendars.clear

calendar.calendars.delete

calendar.calendars.get

calendar.calendars.insert

calendar.calendars.patch

calendar.calendars.update

calendar.channels.stop

calendar.colors.get

calendar.events.delete

calendar.events.get

calendar.events.import

calendar.events.insert

calendar.events.instances

calendar.events.list

calendar.events.move

calendar.events.patch

calendar.events.quickAdd

calendar.events.update

calendar.events.watch

calendar.freebusy.query

calendar.settings.get

calendar.settings.list

calendar.settings.watch

Types

CalendarListEntry

cleSummary :: Lens' CalendarListEntry (Maybe Text) Source

Title of the calendar. Read-only.

cleEtag :: Lens' CalendarListEntry (Maybe Text) Source

ETag of the resource.

cleLocation :: Lens' CalendarListEntry (Maybe Text) Source

Geographic location of the calendar as free-form text. Optional. Read-only.

cleKind :: Lens' CalendarListEntry Text Source

Type of the resource ("calendar#calendarListEntry").

cleNotificationSettings :: Lens' CalendarListEntry (Maybe CalendarListEntryNotificationSettings) Source

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

cleBackgRoundColor :: Lens' CalendarListEntry (Maybe Text) Source

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.

cleForegRoundColor :: Lens' CalendarListEntry (Maybe Text) Source

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.

cleDefaultReminders :: Lens' CalendarListEntry [EventReminder] Source

The default reminders that the authenticated user has for this calendar.

cleSelected :: Lens' CalendarListEntry Bool Source

Whether the calendar content shows up in the calendar UI. Optional. The default is False.

clePrimary :: Lens' CalendarListEntry Bool Source

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

cleHidden :: Lens' CalendarListEntry Bool Source

Whether the calendar has been hidden from the list. Optional. The default is False.

cleId :: Lens' CalendarListEntry (Maybe Text) Source

Identifier of the calendar.

cleDeleted :: Lens' CalendarListEntry Bool Source

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

cleAccessRole :: Lens' CalendarListEntry (Maybe Text) Source

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.

cleSummaryOverride :: Lens' CalendarListEntry (Maybe Text) Source

The summary that the authenticated user has set for this calendar. Optional.

cleColorId :: Lens' CalendarListEntry (Maybe Text) Source

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.

cleTimeZone :: Lens' CalendarListEntry (Maybe Text) Source

The time zone of the calendar. Optional. Read-only.

cleDescription :: Lens' CalendarListEntry (Maybe Text) Source

Description of the calendar. Optional. Read-only.

Event

eSummary :: Lens' Event (Maybe Text) Source

Title of the event.

eOriginalStartTime :: Lens' Event (Maybe EventDateTime) Source

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.

eCreator :: Lens' Event (Maybe EventCreator) Source

The creator of the event. Read-only.

eStatus :: Lens' Event (Maybe Text) Source

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.

eGuestsCanModify :: Lens' Event Bool Source

Whether attendees other than the organizer can modify the event. Optional. The default is False.

eEtag :: Lens' Event (Maybe Text) Source

ETag of the resource.

eAttachments :: Lens' Event [EventAttachment] Source

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,

eLocked :: Lens' Event Bool Source

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.

eLocation :: Lens' Event (Maybe Text) Source

Geographic location of the event as free-form text. Optional.

eAttendees :: Lens' Event [EventAttendee] Source

The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

eReminders :: Lens' Event (Maybe EventReminders) Source

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

eKind :: Lens' Event Text Source

Type of the resource ("calendar#event").

eCreated :: Lens' Event (Maybe UTCTime) Source

Creation time of the event (as a RFC3339 timestamp). Read-only.

eTransparency :: Lens' Event Text Source

Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - The event blocks time on the calendar. This is the default value. - "transparent" - The event does not block time on the calendar.

eRecurringEventId :: Lens' Event (Maybe Text) Source

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

eStart :: Lens' Event (Maybe EventDateTime) Source

The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

ePrivateCopy :: Lens' Event Bool Source

Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.

eEndTimeUnspecified :: Lens' Event Bool Source

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.

eExtendedProperties :: Lens' Event (Maybe EventExtendedProperties) Source

Extended properties of the event.

eVisibility :: Lens' Event Text Source

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.

eGuestsCanInviteOthers :: Lens' Event Bool Source

Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

eRecurrence :: Lens' Event [Text] Source

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.

eGadget :: Lens' Event (Maybe EventGadget) Source

A gadget that extends this event.

eSequence :: Lens' Event (Maybe Int32) Source

Sequence number as per iCalendar.

eICalUId :: Lens' Event (Maybe Text) Source

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.

eEnd :: Lens' Event (Maybe EventDateTime) Source

The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

eAttendeesOmitted :: Lens' Event Bool Source

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.

eSource :: Lens' Event (Maybe EventSource) Source

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.

eId :: Lens' Event (Maybe Text) Source

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.

eHTMLLink :: Lens' Event (Maybe Text) Source

An absolute link to this event in the Google Calendar Web UI. Read-only.

eUpdated :: Lens' Event (Maybe UTCTime) Source

Last modification time of the event (as a RFC3339 timestamp). Read-only.

eColorId :: Lens' Event (Maybe Text) Source

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.

eAnyoneCanAddSelf :: Lens' Event Bool Source

Whether anyone can invite themselves to the event. Optional. The default is False.

eGuestsCanSeeOtherGuests :: Lens' Event Bool Source

Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

eHangoutLink :: Lens' Event (Maybe Text) Source

An absolute link to the Google+ hangout associated with this event. Read-only.

eDescription :: Lens' Event (Maybe Text) Source

Description of the event. Optional.

eOrganizer :: Lens' Event (Maybe EventOrganizer) Source

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.

CalendarListEntryNotificationSettings

calendarListEntryNotificationSettings :: CalendarListEntryNotificationSettings Source

Creates a value of CalendarListEntryNotificationSettings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ACLRuleScope

aclRuleScope :: ACLRuleScope Source

Creates a value of ACLRuleScope with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

arsValue :: Lens' ACLRuleScope (Maybe Text) Source

The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

arsType :: Lens' ACLRuleScope (Maybe Text) Source

The type of the scope. Possible values are: - "default" - The public scope. This is the default value. - "user" - Limits the scope to a single user. - "group" - Limits the scope to a group. - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

ColorsEvent

data ColorsEvent Source

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.

See: colorsEvent smart constructor.

colorsEvent Source

Creates a value of ColorsEvent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Settings

settings :: Settings Source

Creates a value of Settings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sEtag :: Lens' Settings (Maybe Text) Source

Etag of the collection.

sNextPageToken :: Lens' Settings (Maybe Text) Source

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

sKind :: Lens' Settings Text Source

Type of the collection ("calendar#settings").

sItems :: Lens' Settings [Setting] Source

List of user settings.

sNextSyncToken :: Lens' Settings (Maybe Text) Source

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.

FreeBusyRequestItem

freeBusyRequestItem :: FreeBusyRequestItem Source

Creates a value of FreeBusyRequestItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fbriId :: Lens' FreeBusyRequestItem (Maybe Text) Source

The identifier of a calendar or a group.

EventAttachment

eventAttachment :: EventAttachment Source

Creates a value of EventAttachment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eaFileURL :: Lens' EventAttachment (Maybe Text) Source

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.

eaIconLink :: Lens' EventAttachment (Maybe Text) Source

URL link to the attachment's icon. Read-only.

eaMimeType :: Lens' EventAttachment (Maybe Text) Source

Internet media type (MIME type) of the attachment.

eaFileId :: Lens' EventAttachment (Maybe Text) Source

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.

TimePeriod

timePeriod :: TimePeriod Source

Creates a value of TimePeriod with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tpStart :: Lens' TimePeriod (Maybe UTCTime) Source

The (inclusive) start of the time period.

tpEnd :: Lens' TimePeriod (Maybe UTCTime) Source

The (exclusive) end of the time period.

EventCreator

eventCreator :: EventCreator Source

Creates a value of EventCreator with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ecEmail :: Lens' EventCreator (Maybe Text) Source

The creator's email address, if available.

ecSelf :: Lens' EventCreator Bool Source

Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

ecDisplayName :: Lens' EventCreator (Maybe Text) Source

The creator's name, if available.

ecId :: Lens' EventCreator (Maybe Text) Source

The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API

Error'

error' :: Error' Source

Creates a value of Error with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eDomain :: Lens' Error' (Maybe Text) Source

Domain, or broad category, of the error.

eReason :: Lens' Error' (Maybe Text) Source

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.

ColorDefinition

colorDefinition :: ColorDefinition Source

Creates a value of ColorDefinition with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cdForegRound :: Lens' ColorDefinition (Maybe Text) Source

The foreground color that can be used to write on top of a background with 'background' color.

cdBackgRound :: Lens' ColorDefinition (Maybe Text) Source

The background color associated with this color definition.

EventsListOrderBy

data EventsListOrderBy Source

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

Constructors

StartTime

startTime Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

Updated

updated Order by last modification time (ascending).

Channel

channel :: Channel Source

Creates a value of Channel with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cResourceURI :: Lens' Channel (Maybe Text) Source

A version-specific identifier for the watched resource.

cResourceId :: Lens' Channel (Maybe Text) Source

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

cKind :: Lens' Channel Text Source

Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".

cExpiration :: Lens' Channel (Maybe Int64) Source

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

cToken :: Lens' Channel (Maybe Text) Source

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

cAddress :: Lens' Channel (Maybe Text) Source

The address where notifications are delivered for this channel.

cPayload :: Lens' Channel (Maybe Bool) Source

A Boolean value to indicate whether payload is wanted. Optional.

cParams :: Lens' Channel (Maybe ChannelParams) Source

Additional parameters controlling delivery channel behavior. Optional.

cId :: Lens' Channel (Maybe Text) Source

A UUID or similar unique string that identifies this channel.

cType :: Lens' Channel (Maybe Text) Source

The type of delivery mechanism used for this channel.

FreeBusyCalendar

freeBusyCalendar :: FreeBusyCalendar Source

Creates a value of FreeBusyCalendar with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fbcBusy :: Lens' FreeBusyCalendar [TimePeriod] Source

List of time ranges during which this calendar should be regarded as busy.

fbcErrors :: Lens' FreeBusyCalendar [Error'] Source

Optional error(s) (if computation for the calendar failed).

Setting

setting :: Setting Source

Creates a value of Setting with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

setEtag :: Lens' Setting (Maybe Text) Source

ETag of the resource.

setKind :: Lens' Setting Text Source

Type of the resource ("calendar#setting").

setValue :: Lens' Setting (Maybe Text) Source

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.

setId :: Lens' Setting (Maybe Text) Source

The id of the user setting.

FreeBusyResponseGroups

freeBusyResponseGroups Source

Creates a value of FreeBusyResponseGroups with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fbrgAddtional :: Lens' FreeBusyResponseGroups (HashMap Text FreeBusyGroup) Source

List of calendars that are members of this group.

EventReminders

data EventReminders Source

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

See: eventReminders smart constructor.

eventReminders :: EventReminders Source

Creates a value of EventReminders with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

erOverrides :: Lens' EventReminders [EventReminder] Source

If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

erUseDefault :: Lens' EventReminders (Maybe Bool) Source

Whether the default reminders of the calendar apply to the event.

ColorsCalendar

data ColorsCalendar Source

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.

See: colorsCalendar smart constructor.

colorsCalendar Source

Creates a value of ColorsCalendar with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

CalendarNotification

calendarNotification :: CalendarNotification Source

Creates a value of CalendarNotification with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cnMethod :: Lens' CalendarNotification (Maybe Text) Source

The method used to deliver the notification. Possible values are: - "email" - Reminders are sent via email. - "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.

cnType :: Lens' CalendarNotification (Maybe Text) Source

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 event is changed. - "agenda" - An agenda with the events of the day (sent out in the morning).

EventExtendedPropertiesPrivate

eventExtendedPropertiesPrivate Source

Creates a value of EventExtendedPropertiesPrivate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eeppAddtional :: Lens' EventExtendedPropertiesPrivate (HashMap Text Text) Source

The name of the private property and the corresponding value.

ChannelParams

data ChannelParams Source

Additional parameters controlling delivery channel behavior. Optional.

See: channelParams smart constructor.

channelParams Source

Creates a value of ChannelParams with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cpAddtional :: Lens' ChannelParams (HashMap Text Text) Source

Declares a new parameter by name.

Events

events :: Events Source

Creates a value of Events with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eveSummary :: Lens' Events (Maybe Text) Source

Title of the calendar. Read-only.

eveEtag :: Lens' Events (Maybe Text) Source

ETag of the collection.

eveNextPageToken :: Lens' Events (Maybe Text) Source

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

eveKind :: Lens' Events Text Source

Type of the collection ("calendar#events").

eveItems :: Lens' Events [Event] Source

List of events on the calendar.

eveDefaultReminders :: Lens' Events [EventReminder] Source

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).

eveUpdated :: Lens' Events (Maybe UTCTime) Source

Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

eveAccessRole :: Lens' Events (Maybe Text) Source

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.

eveTimeZone :: Lens' Events (Maybe Text) Source

The time zone of the calendar. Read-only.

eveNextSyncToken :: Lens' Events (Maybe Text) Source

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.

eveDescription :: Lens' Events (Maybe Text) Source

Description of the calendar. Read-only.

EventAttendee

eventAttendee :: EventAttendee Source

Creates a value of EventAttendee with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eaEmail :: Lens' EventAttendee (Maybe Text) Source

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.

eaResponseStatus :: Lens' EventAttendee (Maybe Text) Source

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.

eaSelf :: Lens' EventAttendee Bool Source

Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

eaResource :: Lens' EventAttendee Bool Source

Whether the attendee is a resource. Read-only. The default is False.

eaAdditionalGuests :: Lens' EventAttendee Int32 Source

Number of additional guests. Optional. The default is 0.

eaDisplayName :: Lens' EventAttendee (Maybe Text) Source

The attendee's name, if available. Optional.

eaId :: Lens' EventAttendee (Maybe Text) Source

The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API

eaComment :: Lens' EventAttendee (Maybe Text) Source

The attendee's response comment. Optional.

eaOptional :: Lens' EventAttendee Bool Source

Whether this is an optional attendee. Optional. The default is False.

eaOrganizer :: Lens' EventAttendee (Maybe Bool) Source

Whether the attendee is the organizer of the event. Read-only. The default is False.

Calendar

calendar :: Calendar Source

Creates a value of Calendar with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

calSummary :: Lens' Calendar (Maybe Text) Source

Title of the calendar.

calEtag :: Lens' Calendar (Maybe Text) Source

ETag of the resource.

calLocation :: Lens' Calendar (Maybe Text) Source

Geographic location of the calendar as free-form text. Optional.

calKind :: Lens' Calendar Text Source

Type of the resource ("calendar#calendar").

calId :: Lens' Calendar (Maybe Text) Source

Identifier of the calendar. To retrieve IDs call the calendarList.list() method.

calTimeZone :: Lens' Calendar (Maybe Text) Source

The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

calDescription :: Lens' Calendar (Maybe Text) Source

Description of the calendar. Optional.

FreeBusyResponse

freeBusyResponse :: FreeBusyResponse Source

Creates a value of FreeBusyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fbrTimeMin :: Lens' FreeBusyResponse (Maybe UTCTime) Source

The start of the interval.

fbrKind :: Lens' FreeBusyResponse Text Source

Type of the resource ("calendar#freeBusy").

fbrCalendars :: Lens' FreeBusyResponse (Maybe FreeBusyResponseCalendars) Source

List of free/busy information for calendars.

fbrTimeMax :: Lens' FreeBusyResponse (Maybe UTCTime) Source

The end of the interval.

EventReminder

eventReminder :: EventReminder Source

Creates a value of EventReminder with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

erMethod :: Lens' EventReminder (Maybe Text) Source

The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "sms" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored. - "popup" - Reminders are sent via a UI popup.

erMinutes :: Lens' EventReminder (Maybe Int32) Source

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).

EventExtendedProperties

eventExtendedProperties :: EventExtendedProperties Source

Creates a value of EventExtendedProperties with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eepPrivate :: Lens' EventExtendedProperties (Maybe EventExtendedPropertiesPrivate) Source

Properties that are private to the copy of the event that appears on this calendar.

eepShared :: Lens' EventExtendedProperties (Maybe EventExtendedPropertiesShared) Source

Properties that are shared between copies of the event on other attendees' calendars.

EventDateTime

eventDateTime :: EventDateTime Source

Creates a value of EventDateTime with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

edtDate :: Lens' EventDateTime (Maybe Day) Source

The date, in the format "yyyy-mm-dd", if this is an all-day event.

edtTimeZone :: Lens' EventDateTime (Maybe Text) Source

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.

edtDateTime :: Lens' EventDateTime (Maybe UTCTime) Source

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.

EventOrganizer

data EventOrganizer Source

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.

See: eventOrganizer smart constructor.

eventOrganizer :: EventOrganizer Source

Creates a value of EventOrganizer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eoEmail :: Lens' EventOrganizer (Maybe Text) Source

The organizer's email address, if available. It must be a valid email address as per RFC5322.

eoSelf :: Lens' EventOrganizer Bool Source

Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

eoDisplayName :: Lens' EventOrganizer (Maybe Text) Source

The organizer's name, if available.

eoId :: Lens' EventOrganizer (Maybe Text) Source

The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API

CalendarList

calendarList :: CalendarList Source

Creates a value of CalendarList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

clEtag :: Lens' CalendarList (Maybe Text) Source

ETag of the collection.

clNextPageToken :: Lens' CalendarList (Maybe Text) Source

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

clKind :: Lens' CalendarList Text Source

Type of the collection ("calendar#calendarList").

clItems :: Lens' CalendarList [CalendarListEntry] Source

Calendars that are present on the user's calendar list.

clNextSyncToken :: Lens' CalendarList (Maybe Text) Source

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.

CalendarListListMinAccessRole

data CalendarListListMinAccessRole Source

The minimum access role for the user in the returned entries. Optional. The default is no restriction.

Constructors

FreeBusyReader

freeBusyReader The user can read free/busy information.

Owner

owner The user can read and modify events and access control lists.

Reader

reader The user can read events that are not private.

Writer

writer The user can read and modify events.

EventGadget

eventGadget :: EventGadget Source

Creates a value of EventGadget with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

egHeight :: Lens' EventGadget (Maybe Int32) Source

The gadget's height in pixels. The height must be an integer greater than 0. Optional.

egDisplay :: Lens' EventGadget (Maybe Text) Source

The gadget's display mode. Optional. Possible values are: - "icon" - The gadget displays next to the event's title in the calendar view. - "chip" - The gadget displays when the event is clicked.

egLink :: Lens' EventGadget (Maybe Text) Source

The gadget's URL. The URL scheme must be HTTPS.

egIconLink :: Lens' EventGadget (Maybe Text) Source

The gadget's icon URL. The URL scheme must be HTTPS.

egWidth :: Lens' EventGadget (Maybe Int32) Source

The gadget's width in pixels. The width must be an integer greater than 0. Optional.

egTitle :: Lens' EventGadget (Maybe Text) Source

The gadget's title.

egType :: Lens' EventGadget (Maybe Text) Source

The gadget's type.

EventGadgetPreferences

eventGadgetPreferences Source

Creates a value of EventGadgetPreferences with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

egpAddtional :: Lens' EventGadgetPreferences (HashMap Text Text) Source

The preference name and corresponding value.

FreeBusyRequest

freeBusyRequest :: FreeBusyRequest Source

Creates a value of FreeBusyRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fCalendarExpansionMax :: Lens' FreeBusyRequest (Maybe Int32) Source

Maximal number of calendars for which FreeBusy information is to be provided. Optional.

fTimeMin :: Lens' FreeBusyRequest (Maybe UTCTime) Source

The start of the interval for the query.

fItems :: Lens' FreeBusyRequest [FreeBusyRequestItem] Source

List of calendars and/or groups to query.

fGroupExpansionMax :: Lens' FreeBusyRequest (Maybe Int32) Source

Maximal number of calendar identifiers to be provided for a single group. Optional. An error will be returned for a group with more members than this value.

fTimeZone :: Lens' FreeBusyRequest Text Source

Time zone used in the response. Optional. The default is UTC.

fTimeMax :: Lens' FreeBusyRequest (Maybe UTCTime) Source

The end of the interval for the query.

ACLRule

aclRule :: ACLRule Source

Creates a value of ACLRule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

arEtag :: Lens' ACLRule (Maybe Text) Source

ETag of the resource.

arKind :: Lens' ACLRule Text Source

Type of the resource ("calendar#aclRule").

arRole :: Lens' ACLRule (Maybe Text) Source

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.

arScope :: Lens' ACLRule (Maybe ACLRuleScope) Source

The scope of the rule.

arId :: Lens' ACLRule (Maybe Text) Source

Identifier of the ACL rule.

EventsWatchOrderBy

data EventsWatchOrderBy Source

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

Constructors

EWOBStartTime

startTime Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

EWOBUpdated

updated Order by last modification time (ascending).

EventExtendedPropertiesShared

eventExtendedPropertiesShared Source

Creates a value of EventExtendedPropertiesShared with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eepsAddtional :: Lens' EventExtendedPropertiesShared (HashMap Text Text) Source

The name of the shared property and the corresponding value.

CalendarListWatchMinAccessRole

FreeBusyResponseCalendars

freeBusyResponseCalendars Source

Creates a value of FreeBusyResponseCalendars with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fbrcAddtional :: Lens' FreeBusyResponseCalendars (HashMap Text FreeBusyCalendar) Source

Free/busy expansions for a single calendar.

ACL

acl :: ACL Source

Creates a value of ACL with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aEtag :: Lens' ACL (Maybe Text) Source

ETag of the collection.

aNextPageToken :: Lens' ACL (Maybe Text) Source

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

aKind :: Lens' ACL Text Source

Type of the collection ("calendar#acl").

aItems :: Lens' ACL [ACLRule] Source

List of rules on the access control list.

aNextSyncToken :: Lens' ACL (Maybe Text) Source

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.

Colors

colors :: Colors Source

Creates a value of Colors with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

colEvent :: Lens' Colors (Maybe ColorsEvent) Source

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.

colKind :: Lens' Colors Text Source

Type of the resource ("calendar#colors").

colCalendar :: Lens' Colors (Maybe ColorsCalendar) Source

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.

colUpdated :: Lens' Colors (Maybe UTCTime) Source

Last modification time of the color palette (as a RFC3339 timestamp). Read-only.

FreeBusyGroup

freeBusyGroup :: FreeBusyGroup Source

Creates a value of FreeBusyGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fbgCalendars :: Lens' FreeBusyGroup [Text] Source

List of calendars' identifiers within a group.

fbgErrors :: Lens' FreeBusyGroup [Error'] Source

Optional error(s) (if computation for the group failed).

EventSource

data EventSource Source

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.

See: eventSource smart constructor.

eventSource :: EventSource Source

Creates a value of EventSource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

esURL :: Lens' EventSource (Maybe Text) Source

URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

esTitle :: Lens' EventSource (Maybe Text) Source

Title of the source; for example a title of a web page or an email subject.