google_api_people v0.24.0 GoogleApi.People.V1.Api.ContactGroups View Source
API calls for all endpoints tagged ContactGroups
.
Link to this section Summary
Functions
Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
Create a new contact group owned by the authenticated user.
Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
Modify the members of a contact group owned by the authenticated user.
Update the name of an existing contact group owned by the authenticated user.
Link to this section Functions
people_contact_groups_batch_get(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
people_contact_groups_batch_get(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.People.V1.Model.BatchGetContactGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
Parameters
-
connection
(type:GoogleApi.People.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"). -
:maxMembers
(type:integer()
) - Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members. -
:resourceNames
(type:list(String.t)
) - Required. The resource names of the contact groups to get.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.BatchGetContactGroupsResponse{}}
on success -
{:error, info}
on failure
people_contact_groups_create(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
people_contact_groups_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.People.V1.Model.ContactGroup.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Create a new contact group owned by the authenticated user.
Parameters
-
connection
(type:GoogleApi.People.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.People.V1.Model.CreateContactGroupRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.ContactGroup{}}
on success -
{:error, info}
on failure
people_contact_groups_delete(connection, contact_groups_id, optional_params \\ [], opts \\ [])
View SourceSpecs
people_contact_groups_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.People.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
Parameters
-
connection
(type:GoogleApi.People.V1.Connection.t
) - Connection to server -
contact_groups_id
(type:String.t
) - Part ofresourceName
. Required. The resource name of the contact group 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"). -
:deleteContacts
(type:boolean()
) - Optional. Set to true to also delete the contacts in the specified group.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.Empty{}}
on success -
{:error, info}
on failure
people_contact_groups_get(connection, contact_groups_id, optional_params \\ [], opts \\ [])
View SourceSpecs
people_contact_groups_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.People.V1.Model.ContactGroup.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
Parameters
-
connection
(type:GoogleApi.People.V1.Connection.t
) - Connection to server -
contact_groups_id
(type:String.t
) - Part ofresourceName
. Required. The resource name of the contact group to get. -
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"). -
:maxMembers
(type:integer()
) - Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.ContactGroup{}}
on success -
{:error, info}
on failure
people_contact_groups_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
people_contact_groups_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.People.V1.Model.ListContactGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
Parameters
-
connection
(type:GoogleApi.People.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"). -
:pageSize
(type:integer()
) - Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0. -
:pageToken
(type:String.t
) - Optional. The next_page_token value returned from a previous call to ListContactGroups. Requests the next page of resources. -
:syncToken
(type:String.t
) - Optional. A sync token, returned by a previous call tocontactgroups.list
. Only resources changed since the sync token was created will be returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.ListContactGroupsResponse{}}
on success -
{:error, info}
on failure
people_contact_groups_members_modify(connection, contact_groups_id, optional_params \\ [], opts \\ [])
View SourceSpecs
people_contact_groups_members_modify( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.People.V1.Model.ModifyContactGroupMembersResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Modify the members of a contact group owned by the authenticated user.
The only system contact groups that can have members added are
contactGroups/myContacts
and contactGroups/starred
. Other system
contact groups are deprecated and can only have contacts removed.
Parameters
-
connection
(type:GoogleApi.People.V1.Connection.t
) - Connection to server -
contact_groups_id
(type:String.t
) - Part ofresourceName
. Required. The resource name of the contact group to modify. -
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.People.V1.Model.ModifyContactGroupMembersRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.ModifyContactGroupMembersResponse{}}
on success -
{:error, info}
on failure
people_contact_groups_update(connection, contact_groups_id, optional_params \\ [], opts \\ [])
View SourceSpecs
people_contact_groups_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.People.V1.Model.ContactGroup.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Update the name of an existing contact group owned by the authenticated user.
Parameters
-
connection
(type:GoogleApi.People.V1.Connection.t
) - Connection to server -
contact_groups_id
(type:String.t
) - Part ofcontactGroup.resourceName
. The resource name for the contact group, assigned by the server. An ASCII string, in the form ofcontactGroups/{contact_group_id}
. -
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.People.V1.Model.UpdateContactGroupRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.ContactGroup{}}
on success -
{:error, info}
on failure