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 |
Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once. Authenticate using an OAuth access token from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.
See: Google Proximity Beacon API Reference for proximitybeacon.beacons.register
.
- type BeaconsRegisterResource = "v1beta1" :> ("beacons:register" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Beacon :> Post '[JSON] Beacon)))))))))))
- beaconsRegister :: Beacon -> BeaconsRegister
- data BeaconsRegister
- brXgafv :: Lens' BeaconsRegister (Maybe Text)
- brUploadProtocol :: Lens' BeaconsRegister (Maybe Text)
- brPp :: Lens' BeaconsRegister Bool
- brAccessToken :: Lens' BeaconsRegister (Maybe Text)
- brUploadType :: Lens' BeaconsRegister (Maybe Text)
- brPayload :: Lens' BeaconsRegister Beacon
- brBearerToken :: Lens' BeaconsRegister (Maybe Text)
- brProjectId :: Lens' BeaconsRegister (Maybe Text)
- brCallback :: Lens' BeaconsRegister (Maybe Text)
REST Resource
type BeaconsRegisterResource = "v1beta1" :> ("beacons:register" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Beacon :> Post '[JSON] Beacon))))))))))) Source #
A resource alias for proximitybeacon.beacons.register
method which the
BeaconsRegister
request conforms to.
Creating a Request
Creates a value of BeaconsRegister
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data BeaconsRegister Source #
Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once. Authenticate using an OAuth access token from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.
See: beaconsRegister
smart constructor.
Request Lenses
brUploadProtocol :: Lens' BeaconsRegister (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
brAccessToken :: Lens' BeaconsRegister (Maybe Text) Source #
OAuth access token.
brUploadType :: Lens' BeaconsRegister (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
brBearerToken :: Lens' BeaconsRegister (Maybe Text) Source #
OAuth bearer token.
brProjectId :: Lens' BeaconsRegister (Maybe Text) Source #
The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is used. Optional.
brCallback :: Lens' BeaconsRegister (Maybe Text) Source #
JSONP