happygapi.proximitybeacon.beacons — happygapi 0.4.8

Proximity Beacon API: beacons. Registers, manages, indexes, and searches beacons. See: https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons

activate$ clj

(activate$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/activate

Required parameters: beaconName

Optional parameters: projectId

Activates a beacon. A beacon that is active will return information and attachment data when queried via beaconinfo.getforobserved. Calling this method on an already active beacon will do nothing (but will return a successful response code).

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

attachments-batchDelete$ clj

(attachments-batchDelete$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/attachments/batchDelete

Required parameters: beaconName

Optional parameters: namespacedType, projectId

Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone.

You can optionally specify namespacedType to choose which attachments should be deleted. If you do not specify namespacedType, all your attachments on the given beacon will be deleted. You also may explicitly specify */* to delete all.

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

attachments-create$ clj

(attachments-create$ auth parameters body)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/attachments/create

Required parameters: beaconName

Optional parameters: projectId

Body:

{:creationTimeMs string, :maxDistanceMeters number, :attachmentName string, :namespacedType string, :data string}

Associates the given data with the specified beacon. Attachment data must contain two parts:

<ul> <li>A namespaced type.</li> <li>The actual attachment data itself.</li> </ul> The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length.

Attachment data can be up to 1024 bytes long.

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

attachments-delete$ clj

(attachments-delete$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/attachments/delete

Required parameters: attachmentName

Optional parameters: projectId

Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (attachmentName) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone.

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

attachments-list$ clj

(attachments-list$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/attachments/list

Required parameters: beaconName

Optional parameters: namespacedType, projectId

Returns the attachments for the specified beacon that match the specified namespaced-type pattern.

To control which namespaced types are returned, you add the namespacedType query parameter to the request. You must either use */*, to return all attachments, or the namespace must be one of the ones returned from the namespaces endpoint.

Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit permissions in the Google Developers Console project.

deactivate$ clj

(deactivate$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/deactivate

Required parameters: beaconName

Optional parameters: projectId

Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via beaconinfo.getforobserved. Calling this method on an already inactive beacon will do nothing (but will return a successful response code).

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

decommission$ clj

(decommission$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/decommission

Required parameters: beaconName

Optional parameters: projectId

Decommissions the specified beacon in the service. This beacon will no longer be returned from beaconinfo.getforobserved. This operation is permanent -- you will not be able to re-register a beacon with this ID again.

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

delete$ clj

(delete$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/delete

Required parameters: beaconName

Optional parameters: projectId

Deletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the beacon (including those belonging to other projects). This operation cannot be undone.

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

diagnostics-list$ clj

(diagnostics-list$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/diagnostics/list

Required parameters: beaconName

Optional parameters: pageToken, pageSize, alertFilter, projectId

List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name beacons/-.

Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit permissions in the Google Developers Console project.

get$ clj

(get$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/get

Required parameters: beaconName

Optional parameters: projectId

Returns detailed information about the specified beacon.

Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit permissions in the Google Developers Console project.

Requests may supply an Eddystone-EID beacon name in the form: beacons/4!beaconId where the beaconId is the base16 ephemeral ID broadcast by the beacon. The returned Beacon object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.

list$ clj

(list$ auth parameters)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/list

Required parameters: none

Optional parameters: pageToken, q, pageSize, projectId

Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned.

Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit permissions in the Google Developers Console project.

register$ clj

(register$ auth parameters body)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/register

Required parameters: none

Optional parameters: projectId

Body:

{:description string, :properties {}, :beaconName string, :indoorLevel {:name string}, :provisioningKey string, :status string, :advertisedId {:type string, :id string}, :latLng {:latitude number, :longitude number}, :ephemeralIdRegistration {:rotationPeriodExponent integer, :serviceEcdhPublicKey string, :beaconIdentityKey string, :initialEid string, :beaconEcdhPublicKey string, :initialClockValue string}, :expectedStability string, :placeId string}

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.

update$ clj

(update$ auth parameters body)

https://developers.google.com/beacons/proximity/api/reference/rest/v1beta1/beacons/update

Required parameters: beaconName

Optional parameters: projectId

Body:

{:description string, :properties {}, :beaconName string, :indoorLevel {:name string}, :provisioningKey string, :status string, :advertisedId {:type string, :id string}, :latLng {:latitude number, :longitude number}, :ephemeralIdRegistration {:rotationPeriodExponent integer, :serviceEcdhPublicKey string, :beaconIdentityKey string, :initialEid string, :beaconEcdhPublicKey string, :initialClockValue string}, :expectedStability string, :placeId string}

Updates the information about the specified beacon. Any field that you do not populate in the submitted beacon will be permanently erased, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data.

Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.