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.Users.CreateCompanyRelation

Contents

REST Resource
Creating a Request
Request Lenses

Description

Creates a user's company relation. Affiliates the user to a company.

See: Google Partners API Reference for partners.users.createCompanyRelation.

Synopsis

type UsersCreateCompanyRelationResource = "v2" :> ("users" :> (Capture "userId" Text :> ("companyRelation" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (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] CompanyRelation :> Put '[JSON] CompanyRelation)))))))))))))))))
usersCreateCompanyRelation :: CompanyRelation -> Text -> UsersCreateCompanyRelation
data UsersCreateCompanyRelation
uccrXgafv :: Lens' UsersCreateCompanyRelation (Maybe Xgafv)
uccrUploadProtocol :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrAccessToken :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrUploadType :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrPayload :: Lens' UsersCreateCompanyRelation CompanyRelation
uccrUserId :: Lens' UsersCreateCompanyRelation Text
uccrRequestMetadataPartnersSessionId :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrRequestMetadataLocale :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrRequestMetadataExperimentIds :: Lens' UsersCreateCompanyRelation [Text]
uccrRequestMetadataUserOverridesIPAddress :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrRequestMetadataTrafficSourceTrafficSubId :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrRequestMetadataUserOverridesUserId :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrRequestMetadataTrafficSourceTrafficSourceId :: Lens' UsersCreateCompanyRelation (Maybe Text)
uccrCallback :: Lens' UsersCreateCompanyRelation (Maybe Text)

REST Resource

type UsersCreateCompanyRelationResource = "v2" :> ("users" :> (Capture "userId" Text :> ("companyRelation" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (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] CompanyRelation :> Put '[JSON] CompanyRelation))))))))))))))))) Source #

A resource alias for partners.users.createCompanyRelation method which the UsersCreateCompanyRelation request conforms to.

Creating a Request

usersCreateCompanyRelation Source #

Arguments

:: CompanyRelation	`uccrPayload`
-> Text	`uccrUserId`
-> UsersCreateCompanyRelation

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

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

data UsersCreateCompanyRelation Source #

Creates a user's company relation. Affiliates the user to a company.

See: usersCreateCompanyRelation smart constructor.

Instances

Eq UsersCreateCompanyRelation Source #
Instance details Defined in Network.Google.Resource.Partners.Users.CreateCompanyRelation Methods (==) :: UsersCreateCompanyRelation -> UsersCreateCompanyRelation -> Bool # (/=) :: UsersCreateCompanyRelation -> UsersCreateCompanyRelation -> Bool #
Data UsersCreateCompanyRelation Source #
Instance details Defined in Network.Google.Resource.Partners.Users.CreateCompanyRelation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsersCreateCompanyRelation -> c UsersCreateCompanyRelation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsersCreateCompanyRelation # toConstr :: UsersCreateCompanyRelation -> Constr # dataTypeOf :: UsersCreateCompanyRelation -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UsersCreateCompanyRelation) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsersCreateCompanyRelation) # gmapT :: (forall b. Data b => b -> b) -> UsersCreateCompanyRelation -> UsersCreateCompanyRelation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsersCreateCompanyRelation -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsersCreateCompanyRelation -> r # gmapQ :: (forall d. Data d => d -> u) -> UsersCreateCompanyRelation -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UsersCreateCompanyRelation -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsersCreateCompanyRelation -> m UsersCreateCompanyRelation # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersCreateCompanyRelation -> m UsersCreateCompanyRelation # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersCreateCompanyRelation -> m UsersCreateCompanyRelation #
Show UsersCreateCompanyRelation Source #
Instance details Defined in Network.Google.Resource.Partners.Users.CreateCompanyRelation Methods showsPrec :: Int -> UsersCreateCompanyRelation -> ShowS # show :: UsersCreateCompanyRelation -> String # showList :: [UsersCreateCompanyRelation] -> ShowS #
Generic UsersCreateCompanyRelation Source #
Instance details Defined in Network.Google.Resource.Partners.Users.CreateCompanyRelation Associated Types type Rep UsersCreateCompanyRelation :: Type -> Type # Methods from :: UsersCreateCompanyRelation -> Rep UsersCreateCompanyRelation x # to :: Rep UsersCreateCompanyRelation x -> UsersCreateCompanyRelation #
GoogleRequest UsersCreateCompanyRelation Source #
Instance details Defined in Network.Google.Resource.Partners.Users.CreateCompanyRelation Associated Types type Rs UsersCreateCompanyRelation :: Type # type Scopes UsersCreateCompanyRelation :: [Symbol] # Methods requestClient :: UsersCreateCompanyRelation -> GClient (Rs UsersCreateCompanyRelation) #
type Rep UsersCreateCompanyRelation Source #
Instance details Defined in Network.Google.Resource.Partners.Users.CreateCompanyRelation type Rep UsersCreateCompanyRelation = D1 (MetaData "UsersCreateCompanyRelation" "Network.Google.Resource.Partners.Users.CreateCompanyRelation" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "UsersCreateCompanyRelation'" PrefixI True) (((S1 (MetaSel (Just "_uccrXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_uccrUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_uccrAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_uccrUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_uccrPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CompanyRelation)) :: (S1 (MetaSel (Just "_uccrUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_uccrRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 (MetaSel (Just "_uccrRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_uccrRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_uccrRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_uccrRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_uccrRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_uccrRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uccrCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes UsersCreateCompanyRelation Source #
Instance details Defined in Network.Google.Resource.Partners.Users.CreateCompanyRelation type Scopes UsersCreateCompanyRelation = ([] :: [Symbol])
type Rs UsersCreateCompanyRelation Source #
Instance details Defined in Network.Google.Resource.Partners.Users.CreateCompanyRelation type Rs UsersCreateCompanyRelation = CompanyRelation

Request Lenses

uccrXgafv :: Lens' UsersCreateCompanyRelation (Maybe Xgafv) Source #

V1 error format.

uccrUploadProtocol :: Lens' UsersCreateCompanyRelation (Maybe Text) Source #

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

uccrAccessToken :: Lens' UsersCreateCompanyRelation (Maybe Text) Source #

OAuth access token.

uccrUploadType :: Lens' UsersCreateCompanyRelation (Maybe Text) Source #

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

uccrPayload :: Lens' UsersCreateCompanyRelation CompanyRelation Source #

Multipart request metadata.

uccrUserId :: Lens' UsersCreateCompanyRelation Text Source #

The ID of the user. Can be set to me to mean the currently authenticated user.

uccrRequestMetadataPartnersSessionId :: Lens' UsersCreateCompanyRelation (Maybe Text) Source #

Google Partners session ID.

uccrRequestMetadataLocale :: Lens' UsersCreateCompanyRelation (Maybe Text) Source #

Locale to use for the current request.

uccrRequestMetadataExperimentIds :: Lens' UsersCreateCompanyRelation [Text] Source #

Experiment IDs the current request belongs to.

uccrRequestMetadataUserOverridesIPAddress :: Lens' UsersCreateCompanyRelation (Maybe Text) Source #

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

uccrRequestMetadataTrafficSourceTrafficSubId :: Lens' UsersCreateCompanyRelation (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.

uccrRequestMetadataUserOverridesUserId :: Lens' UsersCreateCompanyRelation (Maybe Text) Source #

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

uccrRequestMetadataTrafficSourceTrafficSourceId :: Lens' UsersCreateCompanyRelation (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.

uccrCallback :: Lens' UsersCreateCompanyRelation (Maybe Text) Source #

JSONP