google_api_mirror v0.6.0 GoogleApi.Mirror.V1.Api.Contacts View Source

API calls for all endpoints tagged Contacts.

Link to this section Summary

Functions

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

Deletes a contact.

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

Gets a single contact by ID.

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

Inserts a new contact.

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

Retrieves a list of contacts for the authenticated user.

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

Updates a contact in place. This method supports patch semantics.

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

Updates a contact in place.

Link to this section Functions

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

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

Deletes a contact.

Parameters

connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
id (type: String.t) - The ID of the contact.
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_contacts_get(connection, id, optional_params \\ [], opts \\ [])

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

Gets a single contact by ID.

Parameters

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

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

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

Inserts a new contact.

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.Contact.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Retrieves a list of contacts 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.
opts (type: keyword()) - Call options

Returns

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

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

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

Updates a contact 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 contact.
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.Contact.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Updates a contact in place.

Parameters

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

Returns

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