Skip to content

GooglecalendarClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewEventInCalendar': {'operation_id': 'OnNewEventInCalendar', 'path': '/{connectionId}/trigger1/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventList'}, 'OnUpdatedEventInCalendar': {'operation_id': 'OnUpdatedEventInCalendar', 'path': '/{connectionId}/trigger2/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventList'}, 'OnDeletedEventInCalendar': {'operation_id': 'OnDeletedEventInCalendar', 'path': '/{connectionId}/trigger3/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventList'}, 'OnChangedEventInCalendar': {'operation_id': 'OnChangedEventInCalendar', 'path': '/{connectionId}/trigger4/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventChangedList'}, 'OnEventStarted': {'operation_id': 'OnEventStarted', 'path': '/{connectionId}/eventstarted/calendars/{calendar_id}/events', 'method': 'get', 'required_parameters': ['calendar_id'], 'callback_payload_type': 'CalendarEventList'}}

Classes

CalendarList dataclass

CalendarList(items: Optional[List[CalendarListEntry]] = None)

Response for List calendars

Attributes

items class-attribute instance-attribute
items: Optional[List[CalendarListEntry]] = None

Calendars in the list.

CalendarEventList dataclass

CalendarEventList(items: Optional[List[ResponseEvent]] = None)

Response for List the events on a calendar

Attributes

items class-attribute instance-attribute
items: Optional[List[ResponseEvent]] = None

Events in the calendar.

ResponseEvent dataclass

ResponseEvent(summary: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, status: Optional[str] = None, html_link: Optional[str] = None, id: Optional[str] = None, attendees: Optional[str] = None, creator: Optional[str] = None, organizer: Optional[str] = None, created: Optional[str] = None, updated: Optional[str] = None, end_time_unspecified: Optional[bool] = None)

Response for Create an event

Attributes

summary class-attribute instance-attribute
summary: Optional[str] = None

A summary of the event.

start class-attribute instance-attribute
start: Optional[str] = None

The (inclusive) start time of the event.

end class-attribute instance-attribute
end: Optional[str] = None

The (exclusive) end time of the event.

description class-attribute instance-attribute
description: Optional[str] = None

Description of the event.

location class-attribute instance-attribute
location: Optional[str] = None

Geographic location of the event as free-form text.

status class-attribute instance-attribute
status: Optional[str] = None

Status of the event. Possible values are "confirmed", "tentative", or "cancelled".

html_link: Optional[str] = field(default=None, metadata={'wire_name': 'htmlLink'})

Unique ID of the list.

id class-attribute instance-attribute
id: Optional[str] = None

Opaque identifier of the event.

attendees class-attribute instance-attribute
attendees: Optional[str] = None

The event's attendees.

creator class-attribute instance-attribute
creator: Optional[str] = None

The creator of the event.

organizer class-attribute instance-attribute
organizer: Optional[str] = None

The organizer of the event.

created class-attribute instance-attribute
created: Optional[str] = None

Creation time of the event.

updated class-attribute instance-attribute
updated: Optional[str] = None

Last modification time of the event.

end_time_unspecified class-attribute instance-attribute
end_time_unspecified: Optional[bool] = field(default=None, metadata={'wire_name': 'endTimeUnspecified'})

Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True.

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Response for Delete an event

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CalendarEventChangedList dataclass

CalendarEventChangedList(items: Optional[List[ResponseEventWithActionType]] = None)

Response for When an event is added, updated or deleted from a calendar

Attributes

items class-attribute instance-attribute
items: Optional[List[ResponseEventWithActionType]] = None

Changed events in the calendar.

CalendarListEntry dataclass

CalendarListEntry(id: Optional[str] = None, summary: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, time_zone: Optional[str] = None)

Definition: CalendarListEntry

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

Identifier of the calendar.

summary class-attribute instance-attribute
summary: Optional[str] = None

Title of the calendar.

description class-attribute instance-attribute
description: Optional[str] = None

Description of the calendar.

location class-attribute instance-attribute
location: Optional[str] = None

Geographic location of the calendar as free-form text.

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'timeZone'})

The time zone of the calendar.

RequestEvent dataclass

RequestEvent(summary: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, attendees: Optional[str] = None, status: Optional[str] = None, is_all_day: Optional[bool] = None)

Definition: RequestEvent

Attributes

summary class-attribute instance-attribute
summary: Optional[str] = None

A summary of the event.

start class-attribute instance-attribute
start: Optional[str] = None

The (inclusive) start time of the event.

end class-attribute instance-attribute
end: Optional[str] = None

The (exclusive) end time of the event.

description class-attribute instance-attribute
description: Optional[str] = None

Description of the event.

location class-attribute instance-attribute
location: Optional[str] = None

Geographic location of the event as free-form text.

attendees class-attribute instance-attribute
attendees: Optional[str] = None

Enter a comma-separated list of attendee emails.

status class-attribute instance-attribute
status: Optional[str] = None

Status of the event. Possible values are "confirmed", "tentative", or "cancelled".

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'isAllDay'})

Is all-day event?

PatchEvent dataclass

PatchEvent(summary: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, attendees: Optional[str] = None, status: Optional[str] = None, is_all_day: Optional[bool] = None)

Definition: PatchEvent

Attributes

summary class-attribute instance-attribute
summary: Optional[str] = None

A summary of the event.

start class-attribute instance-attribute
start: Optional[str] = None

The (inclusive) start time of the event.

end class-attribute instance-attribute
end: Optional[str] = None

The (exclusive) end time of the event.

description class-attribute instance-attribute
description: Optional[str] = None

Description of the event.

location class-attribute instance-attribute
location: Optional[str] = None

Geographic location of the event as free-form text.

attendees class-attribute instance-attribute
attendees: Optional[str] = None

Enter a comma-separated list of attendee emails.

status class-attribute instance-attribute
status: Optional[str] = None

Status of the event. Possible values are "confirmed", "tentative", or "cancelled.

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'isAllDay'})

Is all-day event?

ResponseEventWithActionType dataclass

ResponseEventWithActionType(action_type: Optional[str] = None, summary: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, status: Optional[str] = None, html_link: Optional[str] = None, id: Optional[str] = None, attendees: Optional[str] = None, creator: Optional[str] = None, organizer: Optional[str] = None, created: Optional[str] = None, updated: Optional[str] = None, end_time_unspecified: Optional[bool] = None)

Definition: ResponseEventWithActionType

Attributes

action_type class-attribute instance-attribute
action_type: Optional[str] = field(default=None, metadata={'wire_name': 'actionType'})

Type of action which changed the event in change trigger.

summary class-attribute instance-attribute
summary: Optional[str] = None

A summary of the event.

start class-attribute instance-attribute
start: Optional[str] = None

The (inclusive) start time of the event.

end class-attribute instance-attribute
end: Optional[str] = None

The (exclusive) end time of the event.

description class-attribute instance-attribute
description: Optional[str] = None

Description of the event.

location class-attribute instance-attribute
location: Optional[str] = None

Geographic location of the event as free-form text.

status class-attribute instance-attribute
status: Optional[str] = None

Status of the event. Possible values are "confirmed", "tentative", or "cancelled".

html_link: Optional[str] = field(default=None, metadata={'wire_name': 'htmlLink'})

Unique ID of the list.

id class-attribute instance-attribute
id: Optional[str] = None

Opaque identifier of the event.

attendees class-attribute instance-attribute
attendees: Optional[str] = None

The event's attendees.

creator class-attribute instance-attribute
creator: Optional[str] = None

The creator of the event.

organizer class-attribute instance-attribute
organizer: Optional[str] = None

The organizer of the event.

created class-attribute instance-attribute
created: Optional[str] = None

Creation time of the event.

updated class-attribute instance-attribute
updated: Optional[str] = None

Last modification time of the event.

end_time_unspecified class-attribute instance-attribute
end_time_unspecified: Optional[bool] = field(default=None, metadata={'wire_name': 'endTimeUnspecified'})

Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True.

GooglecalendarClient

GooglecalendarClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for googlecalendar connector.

Initialize a GooglecalendarClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

None
options Optional[ConnectorClientOptions]

Optional connector client options.

None

Methods:

list_calendars_async async
list_calendars_async(min_access_role: Optional[str] = None) -> dict[str, Any] | None

List calendars

This operation is used to list all calendars in your Google account.

list_events_async async
list_events_async(calendar_id: str, time_min: Optional[str] = None, time_max: Optional[str] = None, q: Optional[str] = None) -> dict[str, Any] | None

List the events on a calendar

This operation is used to return the first page of arbitrarily ordered events on the selected calendar.

create_event_async async
create_event_async(input: RequestEvent, calendar_id: str) -> dict[str, Any] | None

Create an event

This operation is used to create an event on a specific calendar.

get_event_async async
get_event_async(calendar_id: str, event_id: str) -> dict[str, Any] | None

Get an event

This operation is used to get the details of a specific event from a calendar.

delete_event_async async
delete_event_async(calendar_id: str, event_id: str) -> dict[str, Any] | None

Delete an event

This operation is used to delete an event from a calendar.

update_event_async async
update_event_async(input: PatchEvent, calendar_id: str, event_id: str) -> dict[str, Any] | None

Update an event

This operation is used to update an existing event on a calendar.

list_writable_calendars_async async
list_writable_calendars_async() -> dict[str, Any] | None

List writable calendars

This operation is used to list all calendars in your Google account that you can write to.