Packages
google_api_people
0.0.1
0.43.0
0.42.0
0.41.0
0.40.7
0.40.6
0.40.5
0.40.4
0.40.3
0.40.2
0.40.1
0.40.0
0.39.5
0.39.4
0.39.3
0.39.2
0.39.1
0.39.0
0.38.1
0.38.0
0.37.8
0.37.7
0.37.6
0.37.5
0.37.4
0.37.3
0.37.2
0.37.1
0.37.0
0.36.1
0.36.0
0.35.0
0.34.1
0.34.0
0.33.0
0.32.6
0.32.5
0.32.4
0.32.3
0.32.2
0.32.1
0.32.0
0.31.0
0.30.0
0.29.0
0.28.0
0.27.1
0.27.0
0.26.1
0.26.0
0.25.0
0.24.0
0.23.3
0.23.2
0.23.1
0.23.0
0.22.0
0.21.0
0.20.1
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.1
0.4.0
0.2.0
0.1.0
0.0.1
People API client library. Provides access to information about profiles and contacts.
Current section
Files
Jump to
Current section
Files
lib/google_api/people/v1/api/people.ex
# Copyright 2017 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.
defmodule GoogleApi.People.V1.Api.People do
@moduledoc """
API calls for all endpoints tagged `People`.
"""
alias GoogleApi.People.V1.Connection
import GoogleApi.People.V1.RequestBuilder
@doc """
Provides a list of the authenticated user's contacts merged with any connected profiles. <br> The request throws a 400 error if 'personFields' is not specified.
## Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- people_id (String): Part of `resourceName`. The resource name to return connections for. Only `people/me` is valid.
- opts (KeywordList): [optional] Optional parameters
- :pp (Boolean): Pretty-print response.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :bearer_token (String): OAuth bearer token.
- :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :request_sync_token (Boolean): Whether the response should include a sync token, which can be used to get all changes since the last request.
- :page_token (String): The token of the page to be returned.
- :request_mask/include_field (String): **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
- :page_size (Integer): The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100.
- :sync_token (String): A sync token, returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned.
- :person_fields (String): **Required.** A field mask to restrict which fields on each person are returned. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * skills * taglines * urls
- :sort_order (String): The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
## Returns
{:ok, %GoogleApi.People.V1.Model.ListConnectionsResponse{}} on success
{:error, info} on failure
"""
@spec people_people_connections_list(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.People.V1.Model.ListConnectionsResponse.t} | {:error, Tesla.Env.t}
def people_people_connections_list(connection, people_id, opts \\ []) do
optional_params = %{
:"pp" => :query,
:"oauth_token" => :query,
:"bearer_token" => :query,
:"upload_protocol" => :query,
:"prettyPrint" => :query,
:"uploadType" => :query,
:"fields" => :query,
:"$.xgafv" => :query,
:"callback" => :query,
:"alt" => :query,
:"key" => :query,
:"access_token" => :query,
:"quotaUser" => :query,
:"requestSyncToken" => :query,
:"pageToken" => :query,
:"requestMask.includeField" => :query,
:"pageSize" => :query,
:"syncToken" => :query,
:"personFields" => :query,
:"sortOrder" => :query
}
%{}
|> method(:get)
|> url("/v1/people/#{people_id}/connections")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.People.V1.Model.ListConnectionsResponse{})
end
@doc """
Create a new contact and return the person resource for that contact.
## Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :pp (Boolean): Pretty-print response.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :bearer_token (String): OAuth bearer token.
- :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :parent (String): The resource name of the owning person resource.
- :body (Person):
## Returns
{:ok, %GoogleApi.People.V1.Model.Person{}} on success
{:error, info} on failure
"""
@spec people_people_create_contact(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.People.V1.Model.Person.t} | {:error, Tesla.Env.t}
def people_people_create_contact(connection, opts \\ []) do
optional_params = %{
:"pp" => :query,
:"oauth_token" => :query,
:"bearer_token" => :query,
:"upload_protocol" => :query,
:"prettyPrint" => :query,
:"uploadType" => :query,
:"fields" => :query,
:"$.xgafv" => :query,
:"callback" => :query,
:"alt" => :query,
:"key" => :query,
:"access_token" => :query,
:"quotaUser" => :query,
:"parent" => :query,
:"body" => :body
}
%{}
|> method(:post)
|> url("/v1/people:createContact")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.People.V1.Model.Person{})
end
@doc """
Delete a contact person. Any non-contact data will not be deleted.
## Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- people_id (String): Part of `resourceName`. The resource name of the contact to delete.
- opts (KeywordList): [optional] Optional parameters
- :pp (Boolean): Pretty-print response.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :bearer_token (String): OAuth bearer token.
- :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
## Returns
{:ok, %GoogleApi.People.V1.Model.Empty{}} on success
{:error, info} on failure
"""
@spec people_people_delete_contact(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.People.V1.Model.Empty.t} | {:error, Tesla.Env.t}
def people_people_delete_contact(connection, people_id, opts \\ []) do
optional_params = %{
:"pp" => :query,
:"oauth_token" => :query,
:"bearer_token" => :query,
:"upload_protocol" => :query,
:"prettyPrint" => :query,
:"uploadType" => :query,
:"fields" => :query,
:"$.xgafv" => :query,
:"callback" => :query,
:"alt" => :query,
:"key" => :query,
:"access_token" => :query,
:"quotaUser" => :query
}
%{}
|> method(:delete)
|> url("/v1/people/#{people_id}:deleteContact")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.People.V1.Model.Empty{})
end
@doc """
Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. <br> The request throws a 400 error if 'personFields' is not specified.
## Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- people_id (String): Part of `resourceName`. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`<var>account_id</var>. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list).
- opts (KeywordList): [optional] Optional parameters
- :pp (Boolean): Pretty-print response.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :bearer_token (String): OAuth bearer token.
- :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :person_fields (String): **Required.** A field mask to restrict which fields on the person are returned. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * skills * taglines * urls
- :request_mask/include_field (String): **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
## Returns
{:ok, %GoogleApi.People.V1.Model.Person{}} on success
{:error, info} on failure
"""
@spec people_people_get(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.People.V1.Model.Person.t} | {:error, Tesla.Env.t}
def people_people_get(connection, people_id, opts \\ []) do
optional_params = %{
:"pp" => :query,
:"oauth_token" => :query,
:"bearer_token" => :query,
:"upload_protocol" => :query,
:"prettyPrint" => :query,
:"uploadType" => :query,
:"fields" => :query,
:"$.xgafv" => :query,
:"callback" => :query,
:"alt" => :query,
:"key" => :query,
:"access_token" => :query,
:"quotaUser" => :query,
:"personFields" => :query,
:"requestMask.includeField" => :query
}
%{}
|> method(:get)
|> url("/v1/people/#{people_id}")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.People.V1.Model.Person{})
end
@doc """
Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. <br> The request throws a 400 error if 'personFields' is not specified.
## Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :pp (Boolean): Pretty-print response.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :bearer_token (String): OAuth bearer token.
- :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :request_mask/include_field (String): **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
- :resource_names (List[String]): The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`<var>account_id</var>. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request.
- :person_fields (String): **Required.** A field mask to restrict which fields on each person are returned. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * skills * taglines * urls
## Returns
{:ok, %GoogleApi.People.V1.Model.GetPeopleResponse{}} on success
{:error, info} on failure
"""
@spec people_people_get_batch_get(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.People.V1.Model.GetPeopleResponse.t} | {:error, Tesla.Env.t}
def people_people_get_batch_get(connection, opts \\ []) do
optional_params = %{
:"pp" => :query,
:"oauth_token" => :query,
:"bearer_token" => :query,
:"upload_protocol" => :query,
:"prettyPrint" => :query,
:"uploadType" => :query,
:"fields" => :query,
:"$.xgafv" => :query,
:"callback" => :query,
:"alt" => :query,
:"key" => :query,
:"access_token" => :query,
:"quotaUser" => :query,
:"requestMask.includeField" => :query,
:"resourceNames" => :query,
:"personFields" => :query
}
%{}
|> method(:get)
|> url("/v1/people:batchGet")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.People.V1.Model.GetPeopleResponse{})
end
@doc """
Update contact data for an existing contact person. Any non-contact data will not be modified. The request throws a 400 error if `updatePersonFields` is not specified. <br> The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated. <br> The request throws a 412 error if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and re-apply their updates to the latest person.
## Parameters
- connection (GoogleApi.People.V1.Connection): Connection to server
- people_id (String): Part of `person.resourceName`. The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`<var>person_id</var>.
- opts (KeywordList): [optional] Optional parameters
- :pp (Boolean): Pretty-print response.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :bearer_token (String): OAuth bearer token.
- :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :update_person_fields (String): **Required.** A field mask to restrict which fields on the person are updated. Valid values are: * addresses * biographies * birthdays * braggingRights * emailAddresses * events * genders * imClients * interests * locales * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * skills * urls
- :body (Person):
## Returns
{:ok, %GoogleApi.People.V1.Model.Person{}} on success
{:error, info} on failure
"""
@spec people_people_update_contact(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.People.V1.Model.Person.t} | {:error, Tesla.Env.t}
def people_people_update_contact(connection, people_id, opts \\ []) do
optional_params = %{
:"pp" => :query,
:"oauth_token" => :query,
:"bearer_token" => :query,
:"upload_protocol" => :query,
:"prettyPrint" => :query,
:"uploadType" => :query,
:"fields" => :query,
:"$.xgafv" => :query,
:"callback" => :query,
:"alt" => :query,
:"key" => :query,
:"access_token" => :query,
:"quotaUser" => :query,
:"updatePersonFields" => :query,
:"body" => :body
}
%{}
|> method(:patch)
|> url("/v1/people/#{people_id}:updateContact")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.People.V1.Model.Person{})
end
end