View Source GoogleApi.Keep.V1.Api.Notes (google_api_keep v0.3.0)
API calls for all endpoints tagged Notes
.
Summary
Functions
Creates a new note.
Deletes a note. Caller must have the OWNER
role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.
Lists notes. Every list call returns a page of results with page_size
as the upper bound of returned items. A page_size
of zero allows the server to choose the upper bound. The ListNotesResponse contains at most page_size
entries. If there are more things left to list, it provides a next_page_token
value. (Page tokens are opaque values.) To get the next page of results, copy the result's next_page_token
into the next request's page_token
. Repeat until the next_page_token
returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.
Creates one or more permissions on the note. Only permissions with the WRITER
role may be created. If adding any permission fails, then the entire request fails and no changes are made.
Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the OWNER
role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.
Functions
@spec keep_notes_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Keep.V1.Model.Note.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new note.
Parameters
-
connection
(type:GoogleApi.Keep.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Keep.V1.Model.Note.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Keep.V1.Model.Note{}}
on success -
{:error, info}
on failure
keep_notes_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec keep_notes_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Keep.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a note. Caller must have the OWNER
role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.
Parameters
-
connection
(type:GoogleApi.Keep.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the note to delete. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Keep.V1.Model.Empty{}}
on success -
{:error, info}
on failure
keep_notes_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec keep_notes_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Keep.V1.Model.Note.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a note.
Parameters
-
connection
(type:GoogleApi.Keep.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Keep.V1.Model.Note{}}
on success -
{:error, info}
on failure
@spec keep_notes_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Keep.V1.Model.ListNotesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists notes. Every list call returns a page of results with page_size
as the upper bound of returned items. A page_size
of zero allows the server to choose the upper bound. The ListNotesResponse contains at most page_size
entries. If there are more things left to list, it provides a next_page_token
value. (Page tokens are opaque values.) To get the next page of results, copy the result's next_page_token
into the next request's page_token
. Repeat until the next_page_token
returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.
Parameters
-
connection
(type:GoogleApi.Keep.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Filter for list results. If no filter is supplied, thetrashed
filter is applied by default. Valid fields to filter by are:create_time
,update_time
,trash_time
, andtrashed
. Filter syntax follows the Google AIP filtering spec. -
:pageSize
(type:integer()
) - The maximum number of results to return. -
:pageToken
(type:String.t
) - The previous page'snext_page_token
field.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Keep.V1.Model.ListNotesResponse{}}
on success -
{:error, info}
on failure
keep_notes_permissions_batch_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec keep_notes_permissions_batch_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Keep.V1.Model.BatchCreatePermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates one or more permissions on the note. Only permissions with the WRITER
role may be created. If adding any permission fails, then the entire request fails and no changes are made.
Parameters
-
connection
(type:GoogleApi.Keep.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The parent resource shared by all Permissions being created. Format:notes/{note}
If this is set, the parent field in the CreatePermission messages must either be empty or match this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Keep.V1.Model.BatchCreatePermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Keep.V1.Model.BatchCreatePermissionsResponse{}}
on success -
{:error, info}
on failure
keep_notes_permissions_batch_delete(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec keep_notes_permissions_batch_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Keep.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the OWNER
role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.
Parameters
-
connection
(type:GoogleApi.Keep.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - The parent resource shared by all permissions being deleted. Format:notes/{note}
If this is set, the parent of all of the permissions specified in the DeletePermissionRequest messages must match this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Keep.V1.Model.BatchDeletePermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Keep.V1.Model.Empty{}}
on success -
{:error, info}
on failure