package gapi-ocaml

You can search for identifiers within the package.

in-package search v0.2.0

gapi-ocaml

Legend:
Library
Module
Module type
Parameter
Class
Class type

module SendUpdates : sig ... end

module OrderBy : sig ... end

val get : 
  ?base_url:string ->
  ?etag:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?timeZone:string ->
  ?maxAttendees:int ->
  ?alwaysIncludeEmail:bool ->
  calendarId:string ->
  eventId:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Returns an event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter etag
Optional ETag.

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter timeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.

parameter maxAttendees
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.

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

parameter calendarId
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.

parameter eventId
Event identifier.

val instances : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?timeZone:string ->
  ?timeMin:GapiDate.t ->
  ?timeMax:GapiDate.t ->
  ?pageToken:string ->
  ?maxResults:int ->
  ?originalStart:string ->
  ?alwaysIncludeEmail:bool ->
  ?showDeleted:bool ->
  ?maxAttendees:int ->
  calendarId:string ->
  eventId:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Events.t * GapiConversation.Session.t

Returns instances of the specified recurring event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter timeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.

parameter timeMin
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.

parameter timeMax
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.

parameter pageToken
Token specifying which result page to return. Optional.

parameter maxResults
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.

parameter originalStart
The original start time of the instance in the result. Optional.

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

parameter showDeleted
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.

parameter maxAttendees
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.

parameter calendarId
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.

parameter eventId
Recurring event identifier.

val quickAdd : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?sendNotifications:bool ->
  ?sendUpdates:SendUpdates.t ->
  calendarId:string ->
  text:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Creates an event based on a simple text string.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter sendNotifications
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.

parameter sendUpdates
Guests who should receive notifications about the creation of the new event.

parameter calendarId
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.

parameter text
The text describing the event to be created.

val list : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?maxResults:int ->
  ?q:string ->
  ?timeZone:string ->
  ?sharedExtendedProperty:string list ->
  ?syncToken:string ->
  ?updatedMin:GapiDate.t ->
  ?maxAttendees:int ->
  ?privateExtendedProperty:string list ->
  ?singleEvents:bool ->
  ?showDeleted:bool ->
  ?orderBy:OrderBy.t ->
  ?alwaysIncludeEmail:bool ->
  ?showHiddenInvitations:bool ->
  ?pageToken:string ->
  ?timeMin:GapiDate.t ->
  ?timeMax:GapiDate.t ->
  ?iCalUID:string ->
  calendarId:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Events.t * GapiConversation.Session.t

Returns events on the specified calendar.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter maxResults
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.

parameter q
Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

parameter timeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.

parameter sharedExtendedProperty
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.

parameter syncToken
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.

parameter updatedMin
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.

parameter maxAttendees
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.

parameter privateExtendedProperty
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.

parameter singleEvents
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.

parameter showDeleted
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.

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

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

parameter showHiddenInvitations
Whether to include hidden invitations in the result. Optional. The default is False.

parameter pageToken
Token specifying which result page to return. Optional.

parameter timeMin
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.

parameter timeMax
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.

parameter iCalUID
Specifies event ID in the iCalendar format to be included in the response. Optional.

parameter calendarId
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.

val delete : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?sendNotifications:bool ->
  ?sendUpdates:SendUpdates.t ->
  calendarId:string ->
  eventId:string ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

Deletes an event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter sendNotifications
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.

parameter sendUpdates
Guests who should receive notifications about the deletion of the event.

parameter calendarId
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.

parameter eventId
Event identifier.

val watch : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?maxResults:int ->
  ?timeMax:GapiDate.t ->
  ?timeZone:string ->
  ?iCalUID:string ->
  ?privateExtendedProperty:string list ->
  ?orderBy:OrderBy.t ->
  ?singleEvents:bool ->
  ?showDeleted:bool ->
  ?q:string ->
  ?sharedExtendedProperty:string list ->
  ?updatedMin:GapiDate.t ->
  ?timeMin:GapiDate.t ->
  ?pageToken:string ->
  ?syncToken:string ->
  ?showHiddenInvitations:bool ->
  ?maxAttendees:int ->
  ?alwaysIncludeEmail:bool ->
  calendarId:string ->
  GapiCalendarV3Model.Channel.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Channel.t * GapiConversation.Session.t

Watch for changes to Events resources.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter maxResults
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.

parameter timeMax
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.

parameter timeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.

parameter iCalUID
Specifies event ID in the iCalendar format to be included in the response. Optional.

parameter privateExtendedProperty
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.

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

parameter singleEvents
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.

parameter showDeleted
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.

parameter q
Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

parameter sharedExtendedProperty
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.

parameter updatedMin
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.

parameter timeMin
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.

parameter pageToken
Token specifying which result page to return. Optional.

parameter syncToken
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.

parameter showHiddenInvitations
Whether to include hidden invitations in the result. Optional. The default is False.

parameter maxAttendees
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.

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

parameter calendarId
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.

val insert : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?conferenceDataVersion:int ->
  ?maxAttendees:int ->
  ?supportsAttachments:bool ->
  ?sendNotifications:bool ->
  ?sendUpdates:SendUpdates.t ->
  calendarId:string ->
  GapiCalendarV3Model.Event.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Creates an event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter conferenceDataVersion
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.

parameter maxAttendees
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.

parameter supportsAttachments
Whether API client performing operation supports event attachments. Optional. The default is False.

parameter sendNotifications
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.

parameter sendUpdates
Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.

parameter calendarId
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.

val patch : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?sendNotifications:bool ->
  ?conferenceDataVersion:int ->
  ?maxAttendees:int ->
  ?alwaysIncludeEmail:bool ->
  ?supportsAttachments:bool ->
  ?sendUpdates:SendUpdates.t ->
  calendarId:string ->
  eventId:string ->
  GapiCalendarV3Model.Event.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Updates an event. This method supports patch semantics.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter sendNotifications
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.

parameter conferenceDataVersion
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.

parameter maxAttendees
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.

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

parameter supportsAttachments
Whether API client performing operation supports event attachments. Optional. The default is False.

parameter sendUpdates
Guests who should receive notifications about the event update (for example, title changes, etc.).

parameter calendarId
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.

parameter eventId
Event identifier.

val move : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?sendNotifications:bool ->
  ?sendUpdates:SendUpdates.t ->
  calendarId:string ->
  eventId:string ->
  destination:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Moves an event to another calendar, i.e. changes an event's organizer.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter sendNotifications
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.

parameter sendUpdates
Guests who should receive notifications about the change of the event's organizer.

parameter calendarId
Calendar identifier of the source calendar where the event currently is on.

parameter eventId
Event identifier.

parameter destination
Calendar identifier of the target calendar where the event is to be moved to.

val update : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?conferenceDataVersion:int ->
  ?sendNotifications:bool ->
  ?supportsAttachments:bool ->
  ?sendUpdates:SendUpdates.t ->
  ?maxAttendees:int ->
  ?alwaysIncludeEmail:bool ->
  calendarId:string ->
  eventId:string ->
  GapiCalendarV3Model.Event.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Updates an event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter conferenceDataVersion
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.

parameter sendNotifications
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.

parameter supportsAttachments
Whether API client performing operation supports event attachments. Optional. The default is False.

parameter sendUpdates
Guests who should receive notifications about the event update (for example, title changes, etc.).

parameter maxAttendees
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.

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

parameter calendarId
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.

parameter eventId
Event identifier.

val import : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?custom_headers:GapiCore.Header.t list ->
  ?supportsAttachments:bool ->
  ?conferenceDataVersion:int ->
  calendarId:string ->
  GapiCalendarV3Model.Event.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Imports an event. This operation is used to add a private copy of an existing event to a calendar.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter custom_headers
Optional HTTP custom headers.

parameter supportsAttachments
Whether API client performing operation supports event attachments. Optional. The default is False.

parameter conferenceDataVersion
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.

parameter calendarId
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.