node.js wrapper for the FluidSurveys V3 API
This library provides a simple abstraction of the FluidSurveys API.
The factory takes an optional third parameter to specify the host (for whitelabels), and defaults to https://fluidsurveys.com
. When specifying the host, please use https
!
View the lastest release API documentation FluidSurveys API.
You can authenticate with one of the following combinations:
- username & key
- username & password
- key & password
var fluidsurveys = require("fluidsurveys"),
api = fluidsurveys("username|key", "password|key"[, "host"]);
api.list("surveys", {group: "testing"}, function(err, arg) {
if (err) {
// Handle the error
}
else {
// `arg` is a list of surveys in the "testing" group
}
});
Entity types are puralized to match collections. You can interact with templates
, surveys
, collectors
, contacts
, embeds
, contact-lists
, & webhooks
.
Creates a new entity, such as surveys
.
Creates a child entity under a parent, such as collectors
under surveys
.
Deletes an entity.
Gets an entity.
Gets a child entity under a parent, such as collectors
under surveys
.
Gets a paginated list of entities.
Gets a paginated list of children under a parent.
Updates an entity.
- Getting a 'survey' will retrieve the 'entity', and it's 'structure'
- Updating a 'survey' supports modifying the 'entity', and/or the 'structure'
The V3 API, and this wrapper are 'beta'. Please report issues you find!
Copyright (c) 2014 Fluidware Inc. Licensed under the MIT license.