# qsr-enterprise-api

> A node package for interacting with the QSR Automations' Enterprise API

Latest version **0.1.1** (published 2022-04-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install qsr-enterprise-api
pnpm add qsr-enterprise-api
yarn add qsr-enterprise-api
bun add qsr-enterprise-api
```

## 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.1.1 |
| Published | 2022-04-07 |
| First published | 2022-04-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.3 MB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Steve Ostopchuck |
| Maintainers | steveostop |

## Links

- npm: https://www.npmjs.com/package/qsr-enterprise-api
- Repository: https://github.com/steveostop/QSR-Enterprise-API
- Homepage: https://github.com/steveostop/QSR-Enterprise-API#readme
- Issues: https://github.com/steveostop/QSR-Enterprise-API/issues
- npm.io page: https://npm.io/package/qsr-enterprise-api

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.26.1

## Recent versions

- 0.1.1 (latest) — 2022-04-07
- 0.1.0 — 2022-04-07

## README

# QSR-Enterprise-API
An NPM package for interaction with QSR Automation's Enterprise API.

The module exposes a QSR Class, see [docs/qsr-enterprise-api/0.1.0/QSR.html](/docs/qsr-enterprise-api/0.1.0/QSR.html)

*This package is in need of thorough testing.*

## Quickstart:
```javascript
const QSR = require('qsr-enterprise-api');

const companyUID = 'ABC123';  // Company UID provided by QSR
const qsr = new QSR(companyUID);

// Get all visits for yesterday
const getVisits = async () => {
    const today = new Date();
    today.setHours(0, 0, 0, 0);
    
    const yesterday = new Date(today);
    yesterday.setDate(yesterday.getDate() - 1);

    const siteUID = 'ZYX987';  // Site UID 
    const visits = await qsr.getAllVisitUpdates(siteUID, yesterday, today).catch(err => {
        console.error(err);
    })
};

getVisits();
```

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