# rockrms

> An API Client for Rock RMS.

Latest version **1.0.0** (published 2020-01-25) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2020-01-25 |
| First published | 2019-06-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Erickson G. Pece |
| Maintainers | avodacs |

## Links

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

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.19.2
- [debug](https://npm.io/package/debug.md) ^4.1.1

## Recent versions

- 1.0.0 (latest) — 2020-01-25
- 0.0.1 — 2019-06-10

## README

# Rock RMS API Client

An API Client for Rock RMS.

## Example

This example demonstrates how to authenticate and pull a list of Defined Values, given a specific Defined Type.  Parameters are as follows:

- **`<USERNAME>`**: A valid username in your Rock installation.
- **`<PASSWORD>`**: The password for the username specified above.
- **`<URL>`**: The URL to your Rock installation, _not_ including `/api`.

```js
const RockClient = require('rockrms');

const client = new RockClient({
  username: '<USERNAME>',
  password: '<PASSWORD>',
  url: '<URL>'
});

(async() => {
  await client.authenticate();

  let definedValues = await client.request({
    path: '/api/DefinedValues',
    params: {
      $filter: `DefinedTypeId eq 84`,
      loadAttributes: 'simple'
    }
  })

  console.dir(definedValues);
})();
```

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