# symphony-api-jeff-modified

> jeff lam's slightly modified node implementation of the symphony api

Latest version **0.15.0** (published 2018-10-16) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install symphony-api-jeff-modified
pnpm add symphony-api-jeff-modified
yarn add symphony-api-jeff-modified
bun add symphony-api-jeff-modified
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.15.0 |
| Published | 2018-10-16 |
| First published | 2017-09-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 51.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Glenn Anderson |
| Maintainers | jefflam |
| Keywords | symphony, node, api |

## Links

- npm: https://www.npmjs.com/package/symphony-api-jeff-modified
- Repository: https://github.com/jefflam/symphony-node-binding
- Homepage: https://github.com/jefflam/symphony-node-binding#readme
- Issues: https://github.com/jefflam/symphony-node-binding/issues
- npm.io page: https://npm.io/package/symphony-api-jeff-modified

## Dependencies (4)

- [q](https://npm.io/package/q.md) ^1.4.1
- [request](https://npm.io/package/request.md) ^2.80.0
- [url-join](https://npm.io/package/url-join.md) ^1.1.0
- [https-proxy-agent](https://npm.io/package/https-proxy-agent.md) ^2.2.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.15.0 (latest) — 2018-10-16
- 0.14.1 — 2018-08-08
- 0.14.0 — 2018-07-24
- 0.13.1 — 2018-07-16
- 0.13.0 — 2018-07-12
- 0.12.1 — 2018-06-30
- 0.12.0 — 2018-06-22
- 0.11.5 — 2018-05-02
- 0.11.4 — 2018-05-02
- 0.11.3 — 2018-04-25
- 0.11.2 — 2018-04-25
- 0.11.1 — 2018-04-25
- 0.11.0 — 2018-04-25
- 0.10.0 — 2018-04-25
- 0.9.0 — 2018-03-21
- … 8 more at https://npm.io/package/symphony-api-jeff-modified/versions

## README

# symphony-api  (forked and modified version by Teleo Studios)
A node.js symphony api implementation

# Installation
To use the library, run this command in your project's root path.

```
npm -install symphony-api --save
```

# Getting Started

## Example

```javascript
var symphonyApi = require('symphony-api');
var fs = require('fs');

var urls = {
	keyUrl: 'https://mypod.symphony.com:8444/keyauth',
	sessionUrl: 'https://mypod.symphony.com:8444/sessionauth',
	agentUrl: 'https://mypod.symphony.com:8444/agent',
	podUrl: 'https://mypod.symphony.com:443/pod'
};


var cert = fs.readFileSync('./certs/bot-cert.pem', {encoding: 'utf-8'});
var key = fs.readFileSync('./certs/bot-key.pem', {encoding: 'utf-8'}),
var passphrase = 'this is my passphrase'

var api = symphonyApi.create(urls);
api.setCerts(cert, key, passphrase)
api.authenticate()
	.then()
	{
		api.stream.list()
			.then(function(streams)
			{
				if (streams.length > 0) api.message.send(streams[0].id, 'text', 'hello there');
			});
	});
```

# Using the API

The api is encapsulated into a single object that is created using `symphonyApi.create();`. Once
authenticated, additional functionality is made available through members of this main object. For instance,
`api.message.send(streamId, 'text', 'hello world')` will send the text 'hello world' to the stream streamId.


## Api

## api.user (UserModel)
## api.feed (FeedModel)
## api.message (MessageModel)
## api.stream (StreamModel)

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