typeform

:warning: This package is no longer maintained. The official Typeform JavaScript SDK can be found at https://www.npmjs.com/package/@typeform/api-client.

---

Unofficial Typeform Node API

This is a client for Node.js to consume the typeform.io API. Community-supported, not endorsed by Typeform; documentation available at docs.typeform.io. If this is all new to you, grab your API key from the TypeformI/O website linked above, and be sure to visit typeform.com.

Getting Started

Installing

> npm install typeform --save

Dependency

ES6 Modules

import typeform from 'typeform'
const api = typeform('<your_api_token>')

ES5 / CommonJS

const typeform = require('typeform')('<your_api_token>')

Usage

Bootstrapping

The API client must be bootstrapped with an API token and optionally provided a version, defaults to latest.

require('typeform')('<your_api_token>'[, 'latest'])

Promises

All methods return a promise in the following pattern:

typeform['<method_name>'].then(
  data => console.dir(data),
  err => console.dir(err)
)

API Reference

typeform.base()

http://docs.typeform.io/docs/base

typeform.createForm(<form_data>)

http://docs.typeform.io/docs/forms

typeform.getForm(<form_id>)

http://docs.typeform.io/docs/forms-1

typeform.createImage(<image_data>)

http://docs.typeform.io/docs/images

typeform.getImage(<image_id>)

http://docs.typeform.io/docs/imagesimage_id

typeform.createDesign(<design_data>)

http://docs.typeform.io/docs/designs

typeform.getDesign(<design_id>)

http://docs.typeform.io/docs/designsdesign_id

typeform.createURL(<url_data>)

http://docs.typeform.io/docs/urls

typeform.getURL(<url_id>)

http://docs.typeform.io/docs/urlsurl_id

typeform.updateURL(<url_id>, <url_data>)

http://docs.typeform.io/docs/urlsurl_id-1

typeform.deleteURL(<url_id>)

http://docs.typeform.io/docs/urlsurl_id-2

License

The MIT License (MIT)

Copyright (c) 2016 Autto <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.