# balihoo-blip-sdk

> Node.JS SDK for the Balihoo Local Information Platform

Latest version **1.8.0** (published 2016-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install balihoo-blip-sdk
pnpm add balihoo-blip-sdk
yarn add balihoo-blip-sdk
bun add balihoo-blip-sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.8.0 |
| Published | 2016-10-17 |
| First published | 2015-03-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jeff Flitton |
| Maintainers | balihoo-dengstrom, jflitton-balihoo |
| Keywords | balihoo |

## Links

- npm: https://www.npmjs.com/package/balihoo-blip-sdk
- Repository: https://github.com/balihoo/balihoo-node-blip-sdk
- Issues: https://github.com/balihoo/balihoo-node-blip-sdk/issues
- npm.io page: https://npm.io/package/balihoo-blip-sdk

## Dependencies (4)

- [clone](https://npm.io/package/clone.md) ^0.2.0
- [request](https://npm.io/package/request.md) ^2.53.0
- [bluebird](https://npm.io/package/bluebird.md) ^2.9.4
- [swagger2-utils](https://npm.io/package/swagger2-utils.md) ^2.0.10

## Recent versions

- 1.8.0 (latest) — 2016-10-17
- 1.7.0 — 2016-06-24
- 1.6.1 — 2016-03-23
- 1.6.0 — 2016-03-22
- 1.0.17 — 2015-05-20
- 1.0.13 — 2015-05-08
- 1.0.12 — 2015-05-08
- 1.0.11 — 2015-05-07
- 1.0.10 — 2015-05-07
- 1.0.9 — 2015-03-12
- 1.0.8 — 2015-03-12
- 1.0.7 — 2015-03-12
- 1.0.6 — 2015-03-11
- 1.0.5 — 2015-03-04
- 1.0.4 — 2015-03-04
- … 3 more at https://npm.io/package/balihoo-blip-sdk/versions

## README

[![Build Status](https://img.shields.io/travis/balihoo/balihoo-blip-sdk-node.svg?branch=master&style=flat)](https://travis-ci.org/balihoo/balihoo-blip-sdk-node) [![npm](https://img.shields.io/npm/v/npm.svg?maxAge=2592000)](https://www.npmjs.com/package/balihoo-blip-sdk)
# Balihoo Node.JS BLIP SDK
This package makes it easy to write software which interacts with the Balihoo Local Information Platform.

## Installation
```bash
npm install balihoo-blip-sdk
```

## Build this README
```bash
coffee tools/generateDocs.coffee --version=<VERSION> > README.md
```

## Usage
```javascript
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. http[s]://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)

---
_Source: https://npm.io/package/balihoo-blip-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._