Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.People.People.UpdateContact

Contents

REST Resource
Creating a Request
Request Lenses

Description

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. The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated. 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.

See: People API Reference for people.people.updateContact.

Synopsis

type PeopleUpdateContactResource = "v1" :> (CaptureMode "resourceName" "updateContact" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updatePersonFields" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Person :> Patch '[JSON] Person)))))))))
peopleUpdateContact :: Text -> Person -> PeopleUpdateContact
data PeopleUpdateContact
pucXgafv :: Lens' PeopleUpdateContact (Maybe Xgafv)
pucUploadProtocol :: Lens' PeopleUpdateContact (Maybe Text)
pucResourceName :: Lens' PeopleUpdateContact Text
pucUpdatePersonFields :: Lens' PeopleUpdateContact (Maybe GFieldMask)
pucAccessToken :: Lens' PeopleUpdateContact (Maybe Text)
pucUploadType :: Lens' PeopleUpdateContact (Maybe Text)
pucPayload :: Lens' PeopleUpdateContact Person
pucCallback :: Lens' PeopleUpdateContact (Maybe Text)

REST Resource

type PeopleUpdateContactResource = "v1" :> (CaptureMode "resourceName" "updateContact" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updatePersonFields" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Person :> Patch '[JSON] Person))))))))) Source #

A resource alias for people.people.updateContact method which the PeopleUpdateContact request conforms to.

Creating a Request

peopleUpdateContact Source #

Arguments

:: Text	`pucResourceName`
-> Person	`pucPayload`
-> PeopleUpdateContact

Creates a value of PeopleUpdateContact with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data PeopleUpdateContact Source #

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. The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated. 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.

See: peopleUpdateContact smart constructor.

Instances

Eq PeopleUpdateContact Source #
Instance details Defined in Network.Google.Resource.People.People.UpdateContact Methods (==) :: PeopleUpdateContact -> PeopleUpdateContact -> Bool # (/=) :: PeopleUpdateContact -> PeopleUpdateContact -> Bool #
Data PeopleUpdateContact Source #
Instance details Defined in Network.Google.Resource.People.People.UpdateContact Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PeopleUpdateContact -> c PeopleUpdateContact # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PeopleUpdateContact # toConstr :: PeopleUpdateContact -> Constr # dataTypeOf :: PeopleUpdateContact -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PeopleUpdateContact) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PeopleUpdateContact) # gmapT :: (forall b. Data b => b -> b) -> PeopleUpdateContact -> PeopleUpdateContact # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PeopleUpdateContact -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PeopleUpdateContact -> r # gmapQ :: (forall d. Data d => d -> u) -> PeopleUpdateContact -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PeopleUpdateContact -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PeopleUpdateContact -> m PeopleUpdateContact # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PeopleUpdateContact -> m PeopleUpdateContact # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PeopleUpdateContact -> m PeopleUpdateContact #
Show PeopleUpdateContact Source #
Instance details Defined in Network.Google.Resource.People.People.UpdateContact Methods showsPrec :: Int -> PeopleUpdateContact -> ShowS # show :: PeopleUpdateContact -> String # showList :: [PeopleUpdateContact] -> ShowS #
Generic PeopleUpdateContact Source #
Instance details Defined in Network.Google.Resource.People.People.UpdateContact Associated Types type Rep PeopleUpdateContact :: Type -> Type # Methods from :: PeopleUpdateContact -> Rep PeopleUpdateContact x # to :: Rep PeopleUpdateContact x -> PeopleUpdateContact #
GoogleRequest PeopleUpdateContact Source #
Instance details Defined in Network.Google.Resource.People.People.UpdateContact Associated Types type Rs PeopleUpdateContact :: Type # type Scopes PeopleUpdateContact :: [Symbol] # Methods requestClient :: PeopleUpdateContact -> GClient (Rs PeopleUpdateContact) #
type Rep PeopleUpdateContact Source #
Instance details Defined in Network.Google.Resource.People.People.UpdateContact type Rep PeopleUpdateContact = D1 (MetaData "PeopleUpdateContact" "Network.Google.Resource.People.People.UpdateContact" "gogol-people-0.4.0-E13x4gVqkHzANg1IJZFmJ4" False) (C1 (MetaCons "PeopleUpdateContact'" PrefixI True) (((S1 (MetaSel (Just "_pucXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_pucUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pucResourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pucUpdatePersonFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)))) :: ((S1 (MetaSel (Just "_pucAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pucUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pucPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Person) :*: S1 (MetaSel (Just "_pucCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes PeopleUpdateContact Source #
Instance details Defined in Network.Google.Resource.People.People.UpdateContact type Scopes PeopleUpdateContact = "https://www.googleapis.com/auth/contacts" ': ([] :: [Symbol])
type Rs PeopleUpdateContact Source #
Instance details Defined in Network.Google.Resource.People.People.UpdateContact type Rs PeopleUpdateContact = Person

Request Lenses

pucXgafv :: Lens' PeopleUpdateContact (Maybe Xgafv) Source #

V1 error format.

pucUploadProtocol :: Lens' PeopleUpdateContact (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

pucResourceName :: Lens' PeopleUpdateContact Text Source #

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/`person_id.

pucUpdatePersonFields :: Lens' PeopleUpdateContact (Maybe GFieldMask) Source #

*Required.** A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * emailAddresses * events * genders
imClients * interests * locales * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined

pucAccessToken :: Lens' PeopleUpdateContact (Maybe Text) Source #

OAuth access token.

pucUploadType :: Lens' PeopleUpdateContact (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

pucPayload :: Lens' PeopleUpdateContact Person Source #

Multipart request metadata.

pucCallback :: Lens' PeopleUpdateContact (Maybe Text) Source #

JSONP