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.Partners.UpdateCompanies

Contents

REST Resource
Creating a Request
Request Lenses

Description

Update company. Should only be called within the context of an authorized logged in user.

See: Google Partners API Reference for partners.updateCompanies.

Synopsis

type UpdateCompaniesResource = "v2" :> ("companies" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Company :> Patch '[JSON] Company))))))))))))))))
updateCompanies :: Company -> UpdateCompanies
data UpdateCompanies
ucXgafv :: Lens' UpdateCompanies (Maybe Xgafv)
ucUploadProtocol :: Lens' UpdateCompanies (Maybe Text)
ucUpdateMask :: Lens' UpdateCompanies (Maybe GFieldMask)
ucAccessToken :: Lens' UpdateCompanies (Maybe Text)
ucUploadType :: Lens' UpdateCompanies (Maybe Text)
ucPayload :: Lens' UpdateCompanies Company
ucRequestMetadataPartnersSessionId :: Lens' UpdateCompanies (Maybe Text)
ucRequestMetadataLocale :: Lens' UpdateCompanies (Maybe Text)
ucRequestMetadataExperimentIds :: Lens' UpdateCompanies [Text]
ucRequestMetadataUserOverridesIPAddress :: Lens' UpdateCompanies (Maybe Text)
ucRequestMetadataTrafficSourceTrafficSubId :: Lens' UpdateCompanies (Maybe Text)
ucRequestMetadataUserOverridesUserId :: Lens' UpdateCompanies (Maybe Text)
ucRequestMetadataTrafficSourceTrafficSourceId :: Lens' UpdateCompanies (Maybe Text)
ucCallback :: Lens' UpdateCompanies (Maybe Text)

REST Resource

type UpdateCompaniesResource = "v2" :> ("companies" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Company :> Patch '[JSON] Company)))))))))))))))) Source #

A resource alias for partners.updateCompanies method which the UpdateCompanies request conforms to.

Creating a Request

updateCompanies Source #

Arguments

:: Company	`ucPayload`
-> UpdateCompanies

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

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

data UpdateCompanies Source #

Update company. Should only be called within the context of an authorized logged in user.

See: updateCompanies smart constructor.

Instances

Eq UpdateCompanies Source #
Instance details Defined in Network.Google.Resource.Partners.UpdateCompanies Methods (==) :: UpdateCompanies -> UpdateCompanies -> Bool # (/=) :: UpdateCompanies -> UpdateCompanies -> Bool #
Data UpdateCompanies Source #
Instance details Defined in Network.Google.Resource.Partners.UpdateCompanies Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateCompanies -> c UpdateCompanies # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateCompanies # toConstr :: UpdateCompanies -> Constr # dataTypeOf :: UpdateCompanies -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateCompanies) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateCompanies) # gmapT :: (forall b. Data b => b -> b) -> UpdateCompanies -> UpdateCompanies # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateCompanies -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateCompanies -> r # gmapQ :: (forall d. Data d => d -> u) -> UpdateCompanies -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateCompanies -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateCompanies -> m UpdateCompanies # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateCompanies -> m UpdateCompanies # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateCompanies -> m UpdateCompanies #
Show UpdateCompanies Source #
Instance details Defined in Network.Google.Resource.Partners.UpdateCompanies Methods showsPrec :: Int -> UpdateCompanies -> ShowS # show :: UpdateCompanies -> String # showList :: [UpdateCompanies] -> ShowS #
Generic UpdateCompanies Source #
Instance details Defined in Network.Google.Resource.Partners.UpdateCompanies Associated Types type Rep UpdateCompanies :: Type -> Type # Methods from :: UpdateCompanies -> Rep UpdateCompanies x # to :: Rep UpdateCompanies x -> UpdateCompanies #
GoogleRequest UpdateCompanies Source #
Instance details Defined in Network.Google.Resource.Partners.UpdateCompanies Associated Types type Rs UpdateCompanies :: Type # type Scopes UpdateCompanies :: [Symbol] # Methods requestClient :: UpdateCompanies -> GClient (Rs UpdateCompanies) #
type Rep UpdateCompanies Source #
Instance details Defined in Network.Google.Resource.Partners.UpdateCompanies type Rep UpdateCompanies = D1 (MetaData "UpdateCompanies" "Network.Google.Resource.Partners.UpdateCompanies" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "UpdateCompanies'" PrefixI True) (((S1 (MetaSel (Just "_ucXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_ucUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ucUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)))) :: ((S1 (MetaSel (Just "_ucAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ucUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ucPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Company) :: S1 (MetaSel (Just "_ucRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 (MetaSel (Just "_ucRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_ucRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_ucRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_ucRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ucRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ucRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ucCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes UpdateCompanies Source #
Instance details Defined in Network.Google.Resource.Partners.UpdateCompanies type Scopes UpdateCompanies = ([] :: [Symbol])
type Rs UpdateCompanies Source #
Instance details Defined in Network.Google.Resource.Partners.UpdateCompanies type Rs UpdateCompanies = Company

Request Lenses

ucXgafv :: Lens' UpdateCompanies (Maybe Xgafv) Source #

V1 error format.

ucUploadProtocol :: Lens' UpdateCompanies (Maybe Text) Source #

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

ucUpdateMask :: Lens' UpdateCompanies (Maybe GFieldMask) Source #

Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths.

ucAccessToken :: Lens' UpdateCompanies (Maybe Text) Source #

OAuth access token.

ucUploadType :: Lens' UpdateCompanies (Maybe Text) Source #

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

ucPayload :: Lens' UpdateCompanies Company Source #

Multipart request metadata.

ucRequestMetadataPartnersSessionId :: Lens' UpdateCompanies (Maybe Text) Source #

Google Partners session ID.

ucRequestMetadataLocale :: Lens' UpdateCompanies (Maybe Text) Source #

Locale to use for the current request.

ucRequestMetadataExperimentIds :: Lens' UpdateCompanies [Text] Source #

Experiment IDs the current request belongs to.

ucRequestMetadataUserOverridesIPAddress :: Lens' UpdateCompanies (Maybe Text) Source #

IP address to use instead of the user's geo-located IP address.

ucRequestMetadataTrafficSourceTrafficSubId :: Lens' UpdateCompanies (Maybe Text) Source #

Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

ucRequestMetadataUserOverridesUserId :: Lens' UpdateCompanies (Maybe Text) Source #

Logged-in user ID to impersonate instead of the user's ID.

ucRequestMetadataTrafficSourceTrafficSourceId :: Lens' UpdateCompanies (Maybe Text) Source #

Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

ucCallback :: Lens' UpdateCompanies (Maybe Text) Source #

JSONP