google_api_calendar v0.9.0 GoogleApi.Calendar.V3.Api.Calendars View Source
API calls for all endpoints tagged Calendars
.
Link to this section Summary
Functions
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
Returns metadata for a calendar.
Creates a secondary calendar.
Updates metadata for a calendar. This method supports patch semantics.
Updates metadata for a calendar.
Link to this section Functions
calendar_calendars_clear(connection, calendar_id, optional_params \\ [], opts \\ [])
View Sourcecalendar_calendars_clear(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
Parameters
connection
(type:GoogleApi.Calendar.V3.Connection.t
) - Connection to servercalendar_id
(type:String.t
) - 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.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
calendar_calendars_delete(connection, calendar_id, optional_params \\ [], opts \\ [])
View Sourcecalendar_calendars_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
Parameters
connection
(type:GoogleApi.Calendar.V3.Connection.t
) - Connection to servercalendar_id
(type:String.t
) - 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.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
calendar_calendars_get(connection, calendar_id, optional_params \\ [], opts \\ [])
View Sourcecalendar_calendars_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Calendar.V3.Model.Calendar.t()} | {:error, Tesla.Env.t()}
Returns metadata for a calendar.
Parameters
connection
(type:GoogleApi.Calendar.V3.Connection.t
) - Connection to servercalendar_id
(type:String.t
) - 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.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Calendar.V3.Model.Calendar{}}
on success{:error, info}
on failure
calendar_calendars_insert(connection, optional_params \\ [], opts \\ [])
View Sourcecalendar_calendars_insert(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Calendar.V3.Model.Calendar.t()} | {:error, Tesla.Env.t()}
Creates a secondary calendar.
Parameters
connection
(type:GoogleApi.Calendar.V3.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.Calendar.V3.Model.Calendar.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Calendar.V3.Model.Calendar{}}
on success{:error, info}
on failure
calendar_calendars_patch(connection, calendar_id, optional_params \\ [], opts \\ [])
View Sourcecalendar_calendars_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Calendar.V3.Model.Calendar.t()} | {:error, Tesla.Env.t()}
Updates metadata for a calendar. This method supports patch semantics.
Parameters
connection
(type:GoogleApi.Calendar.V3.Connection.t
) - Connection to servercalendar_id
(type:String.t
) - 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.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.Calendar.V3.Model.Calendar.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Calendar.V3.Model.Calendar{}}
on success{:error, info}
on failure
calendar_calendars_update(connection, calendar_id, optional_params \\ [], opts \\ [])
View Sourcecalendar_calendars_update(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Calendar.V3.Model.Calendar.t()} | {:error, Tesla.Env.t()}
Updates metadata for a calendar.
Parameters
connection
(type:GoogleApi.Calendar.V3.Connection.t
) - Connection to servercalendar_id
(type:String.t
) - 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.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.Calendar.V3.Model.Calendar.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Calendar.V3.Model.Calendar{}}
on success{:error, info}
on failure