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 |
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
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:
ucXgafv
ucUploadProtocol
ucUpdateMask
ucAccessToken
ucUploadType
ucPayload
ucRequestMetadataPartnersSessionId
ucRequestMetadataLocale
ucRequestMetadataExperimentIds
ucRequestMetadataUserOverridesIPAddress
ucRequestMetadataTrafficSourceTrafficSubId
ucRequestMetadataUserOverridesUserId
ucRequestMetadataTrafficSourceTrafficSourceId
ucCallback
data UpdateCompanies Source #
Update company. Should only be called within the context of an authorized logged in user.
See: updateCompanies
smart constructor.
Instances
Request Lenses
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").
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