# harmonysite

> Harmony Site Client

Latest version **2.0.1** (published 2022-03-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install harmonysite
pnpm add harmonysite
yarn add harmonysite
bun add harmonysite
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-03-10 |
| First published | 2020-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Michael Barlock |
| Maintainers | barlock |

## Links

- npm: https://www.npmjs.com/package/harmonysite
- Repository: https://github.com/hcamusic/harmonysite
- Homepage: https://github.com/hcamusic/harmonysite#readme
- Issues: https://github.com/hcamusic/harmonysite/issues
- npm.io page: https://npm.io/package/harmonysite

## Dependencies (9)

- [qs](https://npm.io/package/qs.md) ^6.10.3
- [axios](https://npm.io/package/axios.md) ^0.25.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@types/qs](https://npm.io/package/@types/qs.md) ^6.9.7
- [@types/node](https://npm.io/package/@types/node.md) ^16
- [tough-cookie](https://npm.io/package/tough-cookie.md) ^4.0.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.178
- [@types/tough-cookie](https://npm.io/package/@types/tough-cookie.md) ^4.0.1
- [axios-cookiejar-support](https://npm.io/package/axios-cookiejar-support.md) ^2.0.4

## Recent versions

- 2.0.1 (latest) — 2022-03-10
- 2.0.0 — 2022-03-10
- 1.0.0 — 2020-08-08

## README

# HarmonySite Client

Client library for the [HarmonySite API](https://harmonysite.freshdesk.com/support/solutions/articles/43000590537-api-application-programming-interface).

## Usage

Work with [HarmonySite support](https://harmonysite.freshdesk.com/support/solutions/articles/43000590537-api-application-programming-interface) to enable the API for your group.

It's use the api browser (https://myharmonysite.com/dbpage.php?pg=api) to create a token, select the `authorise` option. You can also use `client.authorise` once to get a token, but it's not recommended for normal use.

```js
const HarmonySite = require('harmonysite');

// Instantiate a new choir genius instance with the url of your site
const harmonySite = new HarmonySite('https://www.hcamusic.org');

const username = process.env.HARMONYSITE_USERNAME;
const password = process.env.HARMONYSITE_PASSWORD;

// Log into harmony site, this must be called once before the other
// functions will work. The documentation references a `token` instead of
// usernames and passwords, but the API requires tracking cookies as well,
// so this must be called before any other calls.
await harmony.authorise(username, password);

// Fetch all your users
const members = await harmony.browse({
  table: 'members',
});
```

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