fluidsurveys

0.2.0 • Public • Published

FluidSurveys API wrapper

node.js wrapper for the FluidSurveys V3 API

Introduction

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!

Documentation

View the lastest release API documentation FluidSurveys API.

You can authenticate with one of the following combinations:

  • username & key
  • username & password
  • key & password

Example

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
    }
});

API

Entity types are puralized to match collections. You can interact with templates, surveys, collectors, contacts, embeds, contact-lists, & webhooks.

create( type, data, cb )

Creates a new entity, such as surveys.

createChild ( parentType, parentId, childType, data, cb )

Creates a child entity under a parent, such as collectors under surveys.

delete ( type, id, cb )

Deletes an entity.

get ( type, id, cb )

Gets an entity.

getChild ( parentType, parentId, childType, childId, cb )

Gets a child entity under a parent, such as collectors under surveys.

list ( type, args, cb )

Gets a paginated list of entities.

listChildren ( parentType, parentId, childType, args, cb )

Gets a paginated list of children under a parent.

update ( type, id, data, cb )

Updates an entity.

Caveats

  • Getting a 'survey' will retrieve the 'entity', and it's 'structure'
  • Updating a 'survey' supports modifying the 'entity', and/or the 'structure'

Issues

The V3 API, and this wrapper are 'beta'. Please report issues you find!

License

Copyright (c) 2014 Fluidware Inc. Licensed under the MIT license.

Package Sidebar

Install

npm i fluidsurveys

Weekly Downloads

8

Version

0.2.0

License

none

Last publish

Collaborators

  • fluidware