1.8.0 • Published 9 years ago

balihoo-blip-sdk v1.8.0

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

Build Status npm

Balihoo Node.JS BLIP SDK

This package makes it easy to write software which interacts with the Balihoo Local Information Platform.

Installation

npm install balihoo-blip-sdk

Build this README

coffee tools/generateDocs.coffee --version=<VERSION> > README.md

Usage

var BlipSdk = require('balihoo-blip-sdk');

var parameters = {
    apiKey: '...',
    secretKey: '...'
};

var blipSdk = new BlipSdk(parameters);

Parameters

The following parameters are required:

  • apiKey: The Balihoo-provided API key
  • secretKey: The Balihoo-provided secret key

The following parameters are optional and generally only useful for testing purposes:

  • endpoint (string): The fully qualified URL of BLIP (e.g. https://somehost:port/some/path)
  • concurrency (number): The number of concurrent connections to use. Default is 10, max is 20.
  • version (string): The API version to use. Default value is the latest version.

API

ping()

Returns an indication of service availability

Parameters: none

getSources()

Returns a list of sources

Parameters:

  • brandKey (string): The brand key (required)

createSource()

Create a source

Parameters:

  • brandKey (string): The brand key (required)
  • body (object)
  • source (string): The unique source identifier.
  • type (string): The source type.
  • description (string): A description of the data source.

getProjections()

Returns a list of projections

Parameters:

  • brandKey (string): The brand key (required)

getBrandKeys()

Returns a list of brand keys to which the user has access

Parameters: none

getBrand()

Returns the requested brand details

Parameters:

  • brandKey (string): The brand key (required)

putBrand()

Create or update a brand

Parameters:

  • brandKey (string): The brand key (required)

getLocationKeys()

Returns a list of location keys

Parameters:

  • brandKey (string): The brand key (required)
  • projection (string): Filter list to only locations that exist in this projection. Default is universal.

patchLocations()

Applies the provided patch to each location in the list

Parameters:

  • brandKey (string): The brand key (required)
  • source (string): The source of the location data.
  • body (object)
  • patch (array): The patch to apply.
  • locationKeys (array): The list of locations to which the patch should be applied

getLocationList()

Returns a list of locations

Parameters:

  • brandKey (string): The brand key (required)
  • body (object)
  • query (object): The query to execute.
  • view (object): The view name.
  • paths (array): A list of paths.
  • pageSize (integer): The number of results to return per page.
  • pageNumber (integer): The page index to return.
  • sortColumn (object): The column on which to sort results.
  • sortDirection (object): The sort direction.

getLocationCount()

Returns a count of locations

Parameters:

  • brandKey (string): The brand key (required)
  • body (object)
  • query (object): The query to execute.

getLocation()

Returns a location

Parameters:

  • brandKey (string): The brand key (required)
  • locationKey (string): The location key. (required)
  • projection (string): The data projection to return. Default is universal.
  • includeRefs (string): Set to true to include referenced data.

putLocation()

Creates or updates a location

Parameters:

  • brandKey (string): The brand key (required)
  • locationKey (string): The location key. (required)
  • source (string): The source of the location data.
  • document (object): location data (required)

deleteLocation()

Deletes a location

Parameters:

  • brandKey (string): The brand key (required)
  • locationKey (string): The location key. (required)
  • source (string): The source of the location data.

getEvent()

Returns a specific event object

Parameters:

  • brandKey (string): The brand key (required)
  • locationKey (string): The location key. (required)
  • eventId (string): The event identifier. (required)
  • source (string): The source of the location data.

patchLocation()

Updates a location at the specified event level

Parameters:

  • brandKey (string): The brand key (required)
  • locationKey (string): The location key. (required)
  • eventId (string): The event identifier. (required)
  • source (string): The source of the location data.
  • document (object): location data (required)

deleteEvent()

Attempts to delete an event from a location's projection

Parameters:

  • brandKey (string): The brand key (required)
  • locationKey (string): The location key. (required)
  • eventId (string): The event identifier. (required)
  • source (string): The source of the location data.

getLocationById()

Returns a location

Parameters:

  • locationId (string): The location identifier. (required)
  • projection (string): The data projection to return. Default is universal.
  • includeRefs (string): Set to true to include referenced data.

patchLocationSigned()

Applies the provided patch to the prescribed location

Parameters:

  • locationId (string): The location identifier. (required)
  • patch (string): The patch to be applied (required)
  • source (string): The source of the location data.
  • redirect (string): The URL to which the user should be redirected on success
  • sig (string): The URL signature (required)

getLocationIntersect()

Returns the common data between all location projections

Parameters:

  • body (object)
  • locationIds (array): location IDs

getEvents()

Returns a list of events

Parameters:

  • brandKey (string): The brand key (required)
  • locationKey (string): The location key (required)
  • source (string): Filter events to only those from this source

authorizeUpload()

Returns a signed upload request

Parameters:

  • brandKey (string): The brand key (required)
  • fileMD5 (string): The MD5 hex hash of the file to upload (required)

bulkLoad()

Bulk load locations from a file

Parameters:

  • brandKey (string): The brand key (required)
  • source (string): The source of the location data.
  • s3Path (string): The full S3 URL for the gzipped JSON file (required)
  • implicitDelete (boolean): Whether locations missing from the file should be deleted (required)
  • expectedRecordCount (integer): The number of location records in the file. (required)
  • successEmail (string): The email address to email upon success. Can be a comma-delimited list.
  • failEmail (string): The email address to email upon failure. Can be a comma-delimited list.
  • successCallback (string): The URL to be requested upon success.
  • failCallback (string): The URL to be requested upon failure.

getSchema()

Returns the validation schema for the brand

Parameters:

  • brandKey (string): The brand key (required)

putSchema()

Create or update the validation schema for the brand

Parameters:

  • brandKey (string): The brand key (required)
  • schema (object): schema document (required)

testSchema()

Returns a schema validation report

Parameters:

  • brandKey (string): The brand key (required)
  • body (object)
  • schema (object): A JSON schema document.
  • query (object): A query used to filter the locations used in the schema test.

getDocs()

Returns the API documentation

Parameters: none

whoami()

Returns information on the current logged in user

Parameters: none

logout()

Log out of Stormpath and this site

Parameters: none

idsiteCallback()

Handle the result of Stormpath IDSite login

Parameters:

  • jwtResponse (string): The JWT-encoded result of the login. (required)

idsiteLogout()

Handle the result of logging out of Stormpath

Parameters:

  • jwtResponse (string): The JWT-encoded result of the login. (required)
1.8.0

9 years ago

1.7.0

9 years ago

1.6.1

9 years ago

1.6.0

9 years ago

1.0.17

10 years ago

1.0.13

10 years ago

1.0.12

10 years ago

1.0.11

10 years ago

1.0.10

10 years ago

1.0.9

10 years ago

1.0.8

10 years ago

1.0.7

10 years ago

1.0.6

10 years ago

1.0.5

10 years ago

1.0.4

10 years ago

1.0.3

10 years ago

1.0.2

10 years ago

1.0.1

10 years ago