# wistia-js

> Wistia api for Node.js

Latest version **1.0.0** (published 2017-11-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install wistia-js
pnpm add wistia-js
yarn add wistia-js
bun add wistia-js
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-11-02 |
| First published | 2016-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | xmaestro |
| Maintainers | alanshaw, xmaestro |
| Keywords | wistia-js, wistia |

## Links

- npm: https://www.npmjs.com/package/wistia-js
- Repository: https://github.com/xmaestro/wistia-js
- Homepage: https://github.com/xmaestro/wistia-js#readme
- Issues: https://github.com/xmaestro/wistia-js/issues
- npm.io page: https://npm.io/package/wistia-js

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.75.0

## Recent versions

- 1.0.0 (latest) — 2017-11-02
- 0.0.8 — 2017-02-13
- 0.0.7 — 2016-11-14
- 0.0.6 — 2016-11-10
- 0.0.5 — 2016-11-03
- 0.0.4 — 2016-11-02
- 0.0.3 — 2016-11-01
- 0.0.2 — 2016-11-01
- 0.0.1 — 2016-10-28

## README

# wistia-js : Node.js package for Wistia APIs

Includes

- Data API [Wistia data API docs](https://wistia.com/doc/data-api)
- Upload API [Wistia upload API docs](https://wistia.com/doc/upload-api)

Installation
--------------------------------------

Install it from npm:

```bash
npm install wistia-js
```

Usage
--------------------------------------

```js

var Wistia = require('wistia-js')('<WISTIA_API_KEY>');
var wistiaData = Wistia.WistiaData();
var WistiaUpload = Wistia.WistiaUpload();

//Sample for Data API
wistiaData.accountRead(function(error,data){
    if(error){ console.log(error); }
    console.log(data);
});

//Sample for Upload API, i.e. using URL
WistiaUpload.upload({
    project_id: '<WISTIA_PROJECT_ID>',
    url: 'http://url/to/video.mp4'
}, function (error, data) {
    if (error) {
        console.log(error);
    }
    console.log(data);
});

//Sample for Upload API, i.e. using file stream
WistiaUpload.upload({
    project_id: '<WISTIA_PROJECT_ID>',
    file: fs.createReadStream('//path/to/file.mp4')
}, function (error, data) {
    if (error) {
        console.log(error);
    }
    console.log(data);
});

```
Where **WISTIA_API_KEY** is the API Password you got from the Wistia dashboard and **WISTIA_PROJECT_ID** is the optional Project ID.

## Wistia Data API Functions

### Accounts

- `accountRead(cb)`
- `accountStats(cb)`

### Events

- `eventRead(event_key,cb)`

### Projects

- `projectShow(project_hash_id,cb)`
- `projectCreate(project_data,cb)`
- `projectList([pagination_options], cb)`
- `projectUpdate(project_id,project_data,cb)`
- `projectDelete(project_id,cb)`
- `projectCopy(project_id,copy_options,cb)`

### Project Sharings

- `projectSharingsList(project_id,cb)`
- `projectSharingsShow(project_id,sharing_id,cb)`
- `projectSharingsCreate(project_id,sharing_data,cb)`
- `projectSharingsUpdate(project_id,sharing_id,project_sharing_data,cb)`
- `projectSharingsDelete(project_id,sharing_id,cb)`

### Media

- `mediaShow(media_id,cb)`
- `mediaCopy(media_id,copy_options,cb)`
- `mediaShowStats(media_id,cb)`
- `mediaUpdate(media_id,media_data,cb)`
- `mediaDelete(media_hash_id,cb)`
- `mediaList(project_id,page,per_page,cb)`

### Media Customizations

- `customizationsShow(media_id,cb)`
- `customizationsCreate(media_id,customization_data,cb)`
- `customizationsUpdate(media_id,customization_data,cb)`
- `customizationsDelete(media_id,cb)`

### Captions

- `captionsIndex(media_id,cb)`
- `captionsCreate(media_id,caption_data,cb)`
- `captionsShow(media_id,lang_code,cb)`
- `captionsUpdate(media_id,lang_code,cb)`
- `captionsPurchase(media_id,cb)`

## Wistia Upload API Functions

- `upload(params,cb)`

`cb` is the callback function.

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