Network.Google.ProximityBeacon.Types

Service Configuration

proximityBeaconService :: Service

Default request referring to version v1beta1 of the Google Proximity Beacon API. This contains the host and root path used as a starting point for constructing service requests.

LatLng

data LatLng

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wrapsdecimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)

See: latLng smart constructor.

Instances

Eq LatLng

Data LatLng

Show LatLng

Generic LatLng

ToJSON LatLng

FromJSON LatLng

type Rep LatLng

latLng :: LatLng

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

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

• llLatitude
• llLongitude

llLatitude :: Lens' LatLng (Maybe Double)

The latitude in degrees. It must be in the range [-90.0, +90.0].

llLongitude :: Lens' LatLng (Maybe Double)

The longitude in degrees. It must be in the range [-180.0, +180.0].

AttachmentInfo

data AttachmentInfo

A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons.

See: attachmentInfo smart constructor.

Instances

Eq AttachmentInfo

Data AttachmentInfo

Show AttachmentInfo

Generic AttachmentInfo

ToJSON AttachmentInfo

FromJSON AttachmentInfo

type Rep AttachmentInfo

attachmentInfo :: AttachmentInfo

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

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

• aiData
• aiNamespacedType

aiData :: Lens' AttachmentInfo (Maybe Word8)

An opaque data container for client-provided data.

aiNamespacedType :: Lens' AttachmentInfo (Maybe Text)

Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type, for example scrupulous-wombat-12345/welcome-message

BeaconProperties

data BeaconProperties

Properties of the beacon device, for example battery type or firmware version. Optional.

See: beaconProperties smart constructor.

Instances

Eq BeaconProperties

Data BeaconProperties

Show BeaconProperties

Generic BeaconProperties

ToJSON BeaconProperties

FromJSON BeaconProperties

type Rep BeaconProperties

beaconProperties

Arguments

:: HashMap Text Text

bpAddtional

-> BeaconProperties

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

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

• bpAddtional

bpAddtional :: Lens' BeaconProperties (HashMap Text Text)

Empty

data Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

See: empty smart constructor.

Instances

Eq Empty

Data Empty

Show Empty

Generic Empty

ToJSON Empty

FromJSON Empty

type Rep Empty

empty :: Empty

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

DeleteAttachmentsResponse

data DeleteAttachmentsResponse

Response for a request to delete attachments.

See: deleteAttachmentsResponse smart constructor.

Instances

Eq DeleteAttachmentsResponse

Data DeleteAttachmentsResponse

Show DeleteAttachmentsResponse

Generic DeleteAttachmentsResponse

ToJSON DeleteAttachmentsResponse

FromJSON DeleteAttachmentsResponse

type Rep DeleteAttachmentsResponse

deleteAttachmentsResponse :: DeleteAttachmentsResponse

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

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

• darNumDeleted

darNumDeleted :: Lens' DeleteAttachmentsResponse (Maybe Int32)

The number of attachments that were deleted.

GetInfoForObservedBeaconsRequest

data GetInfoForObservedBeaconsRequest

Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild".

See: getInfoForObservedBeaconsRequest smart constructor.

Instances

Eq GetInfoForObservedBeaconsRequest

Data GetInfoForObservedBeaconsRequest

Show GetInfoForObservedBeaconsRequest

Generic GetInfoForObservedBeaconsRequest

ToJSON GetInfoForObservedBeaconsRequest

FromJSON GetInfoForObservedBeaconsRequest

type Rep GetInfoForObservedBeaconsRequest

getInfoForObservedBeaconsRequest :: GetInfoForObservedBeaconsRequest

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

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

• gifobrObservations
• gifobrNamespacedTypes

gifobrObservations :: Lens' GetInfoForObservedBeaconsRequest [Observation]

The beacons that the client has encountered. At least one must be given.

gifobrNamespacedTypes :: Lens' GetInfoForObservedBeaconsRequest [Text]

Specifies what kind of attachments to include in the response. When given, the response will include only attachments of the given types. When empty, no attachments will be returned. Must be in the format namespace/type. Accepts `*` to specify all types in all namespaces. Optional.

Namespace

data Namespace

An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it.

See: namespace smart constructor.

Instances

Eq Namespace

Data Namespace

Show Namespace

Generic Namespace

ToJSON Namespace

FromJSON Namespace

type Rep Namespace

namespace :: Namespace

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

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

• nServingVisibility
• nNamespaceName

nServingVisibility :: Lens' Namespace (Maybe Text)

Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.

nNamespaceName :: Lens' Namespace (Maybe Text)

Resource name of this namespace. Namespaces names have the format: namespaces/namespace.

ListNamespacesResponse

data ListNamespacesResponse

Response to ListNamespacesRequest that contains all the project's namespaces.

See: listNamespacesResponse smart constructor.

Instances

Eq ListNamespacesResponse

Data ListNamespacesResponse

Show ListNamespacesResponse

Generic ListNamespacesResponse

ToJSON ListNamespacesResponse

FromJSON ListNamespacesResponse

type Rep ListNamespacesResponse

listNamespacesResponse :: ListNamespacesResponse

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

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

• lnrNamespaces

lnrNamespaces :: Lens' ListNamespacesResponse [Namespace]

The attachments that corresponded to the request params.

Date

data Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][] and `google.protobuf.Timestamp`.

See: date smart constructor.

Instances

Eq Date

Data Date

Show Date

Generic Date

ToJSON Date

FromJSON Date

type Rep Date

date :: Date

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

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

• dDay
• dYear
• dMonth

dDay :: Lens' Date (Maybe Int32)

Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.

dYear :: Lens' Date (Maybe Int32)

Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.

dMonth :: Lens' Date (Maybe Int32)

Month of year of date. Must be from 1 to 12.

Beacon

data Beacon

Details of a beacon device.

See: beacon smart constructor.

Instances

Eq Beacon

Data Beacon

Show Beacon

Generic Beacon

ToJSON Beacon

FromJSON Beacon

type Rep Beacon

beacon :: Beacon

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

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

• bLatLng
• bStatus
• bBeaconName
• bIndoorLevel
• bExpectedStability
• bDescription
• bPlaceId
• bAdvertisedId
• bProperties

bLatLng :: Lens' Beacon (Maybe LatLng)

The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.

bStatus :: Lens' Beacon (Maybe Text)

Current status of the beacon. Required.

bBeaconName :: Lens' Beacon (Maybe Text)

Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.

bIndoorLevel :: Lens' Beacon (Maybe IndoorLevel)

The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.

bExpectedStability :: Lens' Beacon (Maybe Text)

Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.

bDescription :: Lens' Beacon (Maybe Text)

Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.

bPlaceId :: Lens' Beacon (Maybe Text)

The Google Places API Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.

bAdvertisedId :: Lens' Beacon (Maybe AdvertisedId)

The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates.

bProperties :: Lens' Beacon (Maybe BeaconProperties)

Properties of the beacon device, for example battery type or firmware version. Optional.

Diagnostics

data Diagnostics

Diagnostics for a single beacon.

See: diagnostics smart constructor.

Instances

Eq Diagnostics

Data Diagnostics

Show Diagnostics

Generic Diagnostics

ToJSON Diagnostics

FromJSON Diagnostics

type Rep Diagnostics

diagnostics :: Diagnostics

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

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

• dAlerts
• dBeaconName
• dEstimatedLowBatteryDate

dAlerts :: Lens' Diagnostics [Text]

An unordered list of Alerts that the beacon has.

dBeaconName :: Lens' Diagnostics (Maybe Text)

Resource name of the beacon.

dEstimatedLowBatteryDate :: Lens' Diagnostics (Maybe Date)

The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date.

ListBeaconAttachmentsResponse

data ListBeaconAttachmentsResponse

Response to ListBeaconAttachments that contains the requested attachments.

See: listBeaconAttachmentsResponse smart constructor.

Instances

Eq ListBeaconAttachmentsResponse

Data ListBeaconAttachmentsResponse

Show ListBeaconAttachmentsResponse

Generic ListBeaconAttachmentsResponse

ToJSON ListBeaconAttachmentsResponse

FromJSON ListBeaconAttachmentsResponse

type Rep ListBeaconAttachmentsResponse

listBeaconAttachmentsResponse :: ListBeaconAttachmentsResponse

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

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

• lbarAttachments

lbarAttachments :: Lens' ListBeaconAttachmentsResponse [BeaconAttachment]

The attachments that corresponded to the request params.

IndoorLevel

data IndoorLevel

Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on.

See: indoorLevel smart constructor.

Instances

Eq IndoorLevel

Data IndoorLevel

Show IndoorLevel

Generic IndoorLevel

ToJSON IndoorLevel

FromJSON IndoorLevel

type Rep IndoorLevel

indoorLevel :: IndoorLevel

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

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

• ilName

ilName :: Lens' IndoorLevel (Maybe Text)

The name of this level.

BeaconInfo

data BeaconInfo

A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons.

See: beaconInfo smart constructor.

Instances

Eq BeaconInfo

Data BeaconInfo

Show BeaconInfo

Generic BeaconInfo

ToJSON BeaconInfo

FromJSON BeaconInfo

type Rep BeaconInfo

beaconInfo :: BeaconInfo

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

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

• biAttachments
• biBeaconName
• biDescription
• biAdvertisedId

biAttachments :: Lens' BeaconInfo [AttachmentInfo]

Attachments matching the type(s) requested. May be empty if no attachment types were requested, or if none matched.

biBeaconName :: Lens' BeaconInfo (Maybe Text)

The name under which the beacon is registered.

biDescription :: Lens' BeaconInfo (Maybe Text)

Free text used to identify or describe the beacon in a registered establishment. For example: "entrance", "room 101", etc. May be empty.

biAdvertisedId :: Lens' BeaconInfo (Maybe AdvertisedId)

The ID advertised by the beacon.

Observation

data Observation

Represents one beacon observed once.

See: observation smart constructor.

Instances

Eq Observation

Data Observation

Show Observation

Generic Observation

ToJSON Observation

FromJSON Observation

type Rep Observation

observation :: Observation

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

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

• oTelemetry
• oTimestampMs
• oAdvertisedId

oTelemetry :: Lens' Observation (Maybe Word8)

The array of telemetry bytes received from the beacon. The server is responsible for parsing it. This field may frequently be empty, as with a beacon that transmits telemetry only occasionally.

oTimestampMs :: Lens' Observation (Maybe Text)

Time when the beacon was observed. Being sourced from a mobile device, this time may be suspect.

oAdvertisedId :: Lens' Observation (Maybe AdvertisedId)

The ID advertised by the beacon the client has encountered. Required.

BeaconAttachment

data BeaconAttachment

Project-specific data associated with a beacon.

See: beaconAttachment smart constructor.

Instances

Eq BeaconAttachment

Data BeaconAttachment

Show BeaconAttachment

Generic BeaconAttachment

ToJSON BeaconAttachment

FromJSON BeaconAttachment

type Rep BeaconAttachment

beaconAttachment :: BeaconAttachment

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

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

• baData
• baAttachmentName
• baNamespacedType

baData :: Lens' BeaconAttachment (Maybe Word8)

An opaque data container for client-provided data. Must be base64 encoded in HTTP requests, and will be so encoded (with padding) in responses. Required.

baAttachmentName :: Lens' BeaconAttachment (Maybe Text)

Resource name of this attachment. Attachment names have the format: beacons/beacon_id/attachments/attachment_id. Leave this empty on creation.

baNamespacedType :: Lens' BeaconAttachment (Maybe Text)

Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required.

ListDiagnosticsResponse

data ListDiagnosticsResponse

Response that contains the requested diagnostics.

See: listDiagnosticsResponse smart constructor.

Instances

Eq ListDiagnosticsResponse

Data ListDiagnosticsResponse

Show ListDiagnosticsResponse

Generic ListDiagnosticsResponse

ToJSON ListDiagnosticsResponse

FromJSON ListDiagnosticsResponse

type Rep ListDiagnosticsResponse

listDiagnosticsResponse :: ListDiagnosticsResponse

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

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

• ldrNextPageToken
• ldrDiagnostics

ldrNextPageToken :: Lens' ListDiagnosticsResponse (Maybe Text)

Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response.

ldrDiagnostics :: Lens' ListDiagnosticsResponse [Diagnostics]

The diagnostics matching the given request.

AdvertisedId

data AdvertisedId

Defines a unique identifier of a beacon as broadcast by the device.

See: advertisedId smart constructor.

Instances

Eq AdvertisedId

Data AdvertisedId

Show AdvertisedId

Generic AdvertisedId

ToJSON AdvertisedId

FromJSON AdvertisedId

type Rep AdvertisedId

advertisedId :: AdvertisedId

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

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

• aiId
• aiType

aiId :: Lens' AdvertisedId (Maybe Word8)

The actual beacon identifier, as broadcast by the beacon hardware. Must be base64 encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.

aiType :: Lens' AdvertisedId (Maybe Text)

Specifies the identifier type. Required.

ListBeaconsResponse

data ListBeaconsResponse

Response that contains list beacon results and pagination help.

See: listBeaconsResponse smart constructor.

Instances

Eq ListBeaconsResponse

Data ListBeaconsResponse

Show ListBeaconsResponse

Generic ListBeaconsResponse

ToJSON ListBeaconsResponse

FromJSON ListBeaconsResponse

type Rep ListBeaconsResponse

listBeaconsResponse :: ListBeaconsResponse

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

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

• lbrNextPageToken
• lbrBeacons
• lbrTotalCount

lbrNextPageToken :: Lens' ListBeaconsResponse (Maybe Text)

An opaque pagination token that the client may provide in their next request to retrieve the next page of results.

lbrBeacons :: Lens' ListBeaconsResponse [Beacon]

The beacons that matched the search criteria.

lbrTotalCount :: Lens' ListBeaconsResponse (Maybe Int64)

Estimate of the total number of beacons matched by the query. Higher values may be less accurate.

GetInfoForObservedBeaconsResponse

data GetInfoForObservedBeaconsResponse

Information about the requested beacons, optionally including attachment data.

See: getInfoForObservedBeaconsResponse smart constructor.

Instances

Eq GetInfoForObservedBeaconsResponse

Data GetInfoForObservedBeaconsResponse

Show GetInfoForObservedBeaconsResponse

Generic GetInfoForObservedBeaconsResponse

ToJSON GetInfoForObservedBeaconsResponse

FromJSON GetInfoForObservedBeaconsResponse

type Rep GetInfoForObservedBeaconsResponse

getInfoForObservedBeaconsResponse :: GetInfoForObservedBeaconsResponse

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

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

• gifobrBeacons

gifobrBeacons :: Lens' GetInfoForObservedBeaconsResponse [BeaconInfo]

Public information about beacons. May be empty if the request matched no beacons.