# @ravenappdev/raven

> raven - Client SDK for Raven Api This is the SDK Documentation of Raven. You can find out more about Raven at [https://ravenapp.dev/](https://ravenapp.dev/).

Latest version **1.0.1** (published 2022-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ravenappdev/raven
pnpm add @ravenappdev/raven
yarn add @ravenappdev/raven
bun add @ravenappdev/raven
```

## 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.1 |
| Published | 2022-05-24 |
| First published | 2022-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 59.4 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | sriyansh, mayanksharma0211 |

## Links

- npm: https://www.npmjs.com/package/@ravenappdev/raven
- Repository: https://github.com/ravenappdev/raven-node
- Homepage: https://github.com/ravenappdev/raven-node#readme
- Issues: https://github.com/ravenappdev/raven-node/issues
- npm.io page: https://npm.io/package/@ravenappdev/raven

## Dependencies (3)

- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [querystring](https://npm.io/package/querystring.md) 0.2.0

## Recent versions

- 1.0.1 (latest) — 2022-05-24
- 1.0.0 — 2022-05-18

## README

# Raven

raven - Client SDK for Raven Api
This is the SDK Documentation of Raven. You can find out more about Raven at [https://ravenapp.dev/](https://ravenapp.dev/).

# Installation (via [npm](https://www.npmjs.com/package/@ravenappdev/raven))

<!-- ### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via: -->

```shell
npm install @ravenappdev/raven --save
```

<!-- #### git

#

If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/raven_api
then install it via:

```shell
    npm install YOUR_USERNAME/raven_api --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming _main.js_ is your entry file):

```shell
browserify main.js > bundle.js
```

Then include _bundle.js_ in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false,
      },
    },
  ];
}
``` -->

# Requirements

You will need to get a Raven API key to get started. You can sign up and create one for free at [ravenapp.dev](https://ravenapp.dev/).

# Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
import { RavenClient } from "raven";

const config = {
  // Configure API key authorization
  apiKey: "YOUR API KEY",
};
const raven = RavenClient(config);

var appId = "appId_example"; // {String} app id of raven app

var event = {
  //event payload for bulk event to be trggered
};

var opts = {
  //other options
  idempotencyKey: uuidv4(),
};

raven.sendBulk({ appId, event, opts }).then(
  function (response) {
    console.log("API called successfully. Returned response: " + response);
  },
  function (error) {
    console.error(error);
  }
);
```

# Documentation for API Endpoints

All URIs are relative to *https://api.ravenapp.dev*

| Class       | Method                                       | HTTP request                                | Description                                          |
| ----------- | -------------------------------------------- | ------------------------------------------- | ---------------------------------------------------- |
| RavenClient | [**sendBulk**](docs/RavenClient.md#sendBulk) | **POST** /v1/apps/{app_id}/events/bulk_send | sends the event in bulk to all the clients specified |
| RavenClient | [**send**](docs/RavenClient.md#send)         | **POST** /v1/apps/{app_id}/events/send      | sends the event to the client specified              |

## Documentation for Models

- [Attachments](docs/Attachments.md)
- [EmailOverride](docs/EmailOverride.md)
- [EmailRecipient](docs/EmailRecipient.md)
- [EventOverride](docs/EventOverride.md)
- [Param](docs/Param.md)
- [ProviderOverride](docs/ProviderOverride.md)
- [PushOverride](docs/PushOverride.md)
- [Response](docs/Response.md)
- [SendEvent](docs/SendEvent.md)
- [SendEventBulk](docs/SendEventBulk.md)
- [SlackOverride](docs/SlackOverride.md)
- [TelegramOverride](docs/TelegramOverride.md)
- [SlackProfile](docs/SlackProfile.md)
- [SmsOverride](docs/SmsOverride.md)
- [User](docs/User.md)
- [VoiceOverride](docs/VoiceOverride.md)
- [WebhookOverride](docs/WebhookOverride.md)
- [WhatsappOverride](docs/WhatsappOverride.md)

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