npm package: @jweb-development/cisco-umbrella
Description: Package for integrating with cisco umbrella api.
Author: JWEB Development LLC
Latest version: 1.0.2

<div align="center">
    <img width="75%" src="https://www.jwebdevelopment.com/wp-content/uploads/2019/11/design_101794_7493754_90969_3b6cab74_image-1.jpg" alt="jweb-logo" />
    <!-- <img width="45%" style="background: #fff; padding: 0.25em" src="https://umbrella.cisco.com/wp-content/themes/umbrella/images/umbrella-logo.svg" alt="cisco-logo"> -->
</div>
<br />

---

[![Npm package version](https://badgen.net/npm/v/@jweb-development/cisco-umbrella?icon=npm)](https://www.npmjs.com/package/@jweb-development/cisco-umbrella)
[![Npm downloads](https://badgen.net/npm/dt/@jweb-development/cisco-umbrella?icon=npm)](https://www.npmjs.com/package/@jweb-development/cisco-umbrella)
[![Github Checks](https://badgen.net/github/checks/jweb-development/cisco-umbrella?icon=github)](https://github.com/jweb-development/cisco-umbrella)
[![Github Status](https://badgen.net/github/status/jweb-development/cisco-umbrella/develop?icon=github)](https://github.com/jweb-development/cisco-umbrella)
[![Github PRs](https://badgen.net/github/prs/jweb-development/cisco-umbrella?icon=github)](https://github.com/jweb-development/cisco-umbrella)
![Package Types](https://badgen.net/npm/types/@jweb-development/cisco-umbrella?icon=typescript)
[![Github Commits](https://badgen.net/github/commits/jweb-development/cisco-umbrella/develop?icon=github)](https://github.com/jweb-development/cisco-umbrella)
[![Github Releases](https://badgen.net/github/releases/jweb-development/cisco-umbrella?icon=github)](https://github.com/jweb-development/cisco-umbrella)
![Package Types](https://badgen.net/npm/types/@jweb-development/cisco-umbrella?icon=typescript)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

# Cisco Umbrella
This package compromises a TypeScript library meant for interacting with Cisco Umbrella's API. 

## Installation
To install type the following:
```shell
npm i @jweb-development/cisco-umbrella
yarn add @jweb-development/cisco-umbrella
```

## Use Case
In order to integrate our current API with Cisco Umbrella's API, we had to design a library capable of managing the integration. To achieve this, the package takes data acquired from our api to be processed by Cisco Umbrella's API. This package currently supports API integration with `Enforcement`, `Destination Lists`, `Destinations`, and `Organizations`.

## Documentation
- ### [API](/docs/api.md)
- ### [Examples](/docs/examples.md)
<!-- - [FAQ](/docs/faq.md) -->

## Contributing

### Development

To run a development copy of @jweb-development/cisco-umbrella, type the following:

```bash
# First we clone the repository
git clone https://github.com/jweb-development/cisco-umbrella.git
cd cisco-umbrella

# Then we install the dependencies
npm install

# Then we build the package
npm run build
```

This will output the files into the `dist` directory.

### Contributors
<a href="https://github.com/jweb-development/cisco-umbrella/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=jweb-development/cisco-umbrella" />
</a>