google_api_mirror v0.4.0 GoogleApi.Mirror.V1.Api.Timeline View Source

mirror_timeline_attachments_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Deletes an attachment from a timeline item.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
item_id (type: String.t) - The ID of the timeline item the attachment belongs to.
attachment_id (type: String.t) - The ID of the attachment.
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

mirror_timeline_attachments_get(connection, item_id, attachment_id, optional_params \\ [], opts \\ [])

mirror_timeline_attachments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Mirror.V1.Model.Attachment.t()} | {:error, Tesla.Env.t()}

Retrieves an attachment on a timeline item by item ID and attachment ID.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
item_id (type: String.t) - The ID of the timeline item the attachment belongs to.
attachment_id (type: String.t) - The ID of the attachment.
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.Mirror.V1.Model.Attachment{}} on success
{:error, info} on failure

mirror_timeline_attachments_insert(connection, item_id, optional_params \\ [], opts \\ [])

mirror_timeline_attachments_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Mirror.V1.Model.Attachment.t()} | {:error, Tesla.Env.t()}

Adds a new attachment to a timeline item.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
item_id (type: String.t) - The ID of the timeline item the attachment belongs to.
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.Mirror.V1.Model.Attachment{}} on success
{:error, info} on failure

mirror_timeline_attachments_insert_resumable(connection, item_id, upload_type, optional_params \\ [], opts \\ [])

mirror_timeline_attachments_insert_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Adds a new attachment to a timeline item.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
item_id (type: String.t) - The ID of the timeline item the attachment belongs to.
upload_type (type: String.t) - Upload type. Must be "resumable".
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

mirror_timeline_attachments_insert_simple(connection, item_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

mirror_timeline_attachments_insert_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Mirror.V1.Model.Attachment.t()} | {:error, Tesla.Env.t()}

Adds a new attachment to a timeline item.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
item_id (type: String.t) - The ID of the timeline item the attachment belongs to.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: String.t) - string metadata
data (type: String.t) - Path to file
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.Mirror.V1.Model.Attachment{}} on success
{:error, info} on failure

mirror_timeline_attachments_list(connection, item_id, optional_params \\ [], opts \\ [])

mirror_timeline_attachments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Mirror.V1.Model.AttachmentsListResponse.t()}
  | {:error, Tesla.Env.t()}

Returns a list of attachments for a timeline item.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
item_id (type: String.t) - The ID of the timeline item whose attachments should be listed.
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.Mirror.V1.Model.AttachmentsListResponse{}} on success
{:error, info} on failure

mirror_timeline_delete(connection, id, optional_params \\ [], opts \\ [])

mirror_timeline_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Deletes a timeline item.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
id (type: String.t) - The ID of the timeline item.
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

mirror_timeline_get(connection, id, optional_params \\ [], opts \\ [])

mirror_timeline_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Mirror.V1.Model.TimelineItem.t()} | {:error, Tesla.Env.t()}

Gets a single timeline item by ID.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
id (type: String.t) - The ID of the timeline item.
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.Mirror.V1.Model.TimelineItem{}} on success
{:error, info} on failure

mirror_timeline_insert(connection, optional_params \\ [], opts \\ [])

mirror_timeline_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Mirror.V1.Model.TimelineItem.t()} | {:error, Tesla.Env.t()}

Inserts a new item into the timeline.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
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.Mirror.V1.Model.TimelineItem.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Mirror.V1.Model.TimelineItem{}} on success
{:error, info} on failure

mirror_timeline_insert_resumable(connection, upload_type, optional_params \\ [], opts \\ [])

mirror_timeline_insert_resumable(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Inserts a new item into the timeline.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
upload_type (type: String.t) - Upload type. Must be "resumable".
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.Mirror.V1.Model.TimelineItem.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

mirror_timeline_insert_simple(connection, upload_type, metadata, data, optional_params \\ [], opts \\ [])

mirror_timeline_insert_simple(
  Tesla.Env.client(),
  String.t(),
  GoogleApi.Mirror.V1.Model.TimelineItem.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Mirror.V1.Model.TimelineItem.t()} | {:error, Tesla.Env.t()}

Inserts a new item into the timeline.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Mirror.V1.Model.TimelineItem.t) - object metadata
data (type: String.t) - Path to file
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.Mirror.V1.Model.TimelineItem{}} on success
{:error, info} on failure

mirror_timeline_list(connection, optional_params \\ [], opts \\ [])

mirror_timeline_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Mirror.V1.Model.TimelineListResponse.t()}
  | {:error, Tesla.Env.t()}

Retrieves a list of timeline items for the authenticated user.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
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.
- :bundleId (type: String.t) - If provided, only items with the given bundleId will be returned.
- :includeDeleted (type: boolean()) - If true, tombstone records for deleted items will be returned.
- :maxResults (type: integer()) - The maximum number of items to include in the response, used for paging.
- :orderBy (type: String.t) - Controls the order in which timeline items are returned.
- :pageToken (type: String.t) - Token for the page of results to return.
- :pinnedOnly (type: boolean()) - If true, only pinned items will be returned.
- :sourceItemId (type: String.t) - If provided, only items with the given sourceItemId will be returned.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Mirror.V1.Model.TimelineListResponse{}} on success
{:error, info} on failure

mirror_timeline_patch(connection, id, optional_params \\ [], opts \\ [])

mirror_timeline_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Mirror.V1.Model.TimelineItem.t()} | {:error, Tesla.Env.t()}

Updates a timeline item in place. This method supports patch semantics.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
id (type: String.t) - The ID of the timeline item.
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.Mirror.V1.Model.TimelineItem.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Mirror.V1.Model.TimelineItem{}} on success
{:error, info} on failure

mirror_timeline_update(connection, id, optional_params \\ [], opts \\ [])

mirror_timeline_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Mirror.V1.Model.TimelineItem.t()} | {:error, Tesla.Env.t()}

Updates a timeline item in place.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
id (type: String.t) - The ID of the timeline item.
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.Mirror.V1.Model.TimelineItem.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Mirror.V1.Model.TimelineItem{}} on success
{:error, info} on failure

mirror_timeline_update_resumable(connection, id, upload_type, optional_params \\ [], opts \\ [])

mirror_timeline_update_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Updates a timeline item in place.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
id (type: String.t) - The ID of the timeline item.
upload_type (type: String.t) - Upload type. Must be "resumable".
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.Mirror.V1.Model.TimelineItem.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

mirror_timeline_update_simple(connection, id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

mirror_timeline_update_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Mirror.V1.Model.TimelineItem.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.Mirror.V1.Model.TimelineItem.t()} | {:error, Tesla.Env.t()}

Updates a timeline item in place.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
id (type: String.t) - The ID of the timeline item.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Mirror.V1.Model.TimelineItem.t) - object metadata
data (type: String.t) - Path to file
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.Mirror.V1.Model.TimelineItem{}} on success
{:error, info} on failure