@seneca/refer/README.md

User Referral business logic plugin for the Seneca platform.

# @seneca/refer

> _Seneca Refer_ is a plugin for [Seneca](http://senecajs.org)

    User referral business logic plugin for the Seneca platform.

[![npm version](https://img.shields.io/npm/v/@seneca/refer.svg)](https://npmjs.com/package/@seneca/refer)
[![build](https://github.com/senecajs/seneca-refer/actions/workflows/build.yml/badge.svg)](https://github.com/senecajs/seneca-refer/actions/workflows/build.yml)
[![Coverage Status](https://coveralls.io/repos/github/senecajs/seneca-refer/badge.svg?branch=main)](https://coveralls.io/github/senecajs/seneca-refer?branch=main)
[![Known Vulnerabilities](https://snyk.io/test/github/senecajs/seneca-refer/badge.svg)](https://snyk.io/test/github/senecajs/seneca-refer)
[![DeepScan grade](https://deepscan.io/api/teams/5016/projects/20872/branches/581541/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=5016&pid=20872&bid=581541)
[![Maintainability](https://api.codeclimate.com/v1/badges/8242b80adb8acb685afd/maintainability)](https://codeclimate.com/github/senecajs/seneca-refer/maintainability)

| ![Voxgig](https://www.voxgig.com/res/img/vgt01r.png) | This open source module is sponsored and supported by [Voxgig](https://www.voxgig.com). |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------- |

## Install

```sh
$ npm install @seneca/refer
```

## Quick Example

```js
// Setup - get the key value (<SECRET>) separately from a vault or
// environment variable.
Seneca().use('refer', {})

TODO
```

<!--START:options-->

## Options

_None._

<!--END:options-->

<!--START:action-list-->


## Action Patterns

* [accept:entry,biz:refer](#-acceptentrybizrefer-)
* [biz:refer,create:entry](#-bizrefercreateentry-)
* [biz:refer,ensure:entry](#-bizreferensureentry-)
* [biz:refer,give:award](#-bizrefergiveaward-)
* [biz:refer,load:entry](#-bizreferloadentry-)
* [biz:refer,load:rules](#-bizreferloadrules-)
* [biz:refer,lost:entry](#-bizreferlostentry-)
* [biz:refer,update:occur](#-bizreferupdateoccur-)
* [biz:refer,update:entry](#-bizreferupdateentry-)


<!--END:action-list-->

<!--START:action-desc-->


## Action Descriptions

### &laquo; `accept:entry,biz:refer` &raquo;

No description provided.



----------
### &laquo; `biz:refer,create:entry` &raquo;

Create referral entry.



----------
### &laquo; `biz:refer,ensure:entry` &raquo;

No description provided.



----------
### &laquo; `biz:refer,give:award` &raquo;

No description provided.



----------
### &laquo; `biz:refer,load:entry` &raquo;

No description provided.



----------
### &laquo; `biz:refer,load:rules` &raquo;

No description provided.



----------
### &laquo; `biz:refer,lost:entry` &raquo;

No description provided.



----------
### &laquo; `biz:refer,update:occur` &raquo;

No description provided.



----------
### &laquo; `biz:refer,update:entry` &raquo;

No description provided.



----------


<!--END:action-desc-->

## More Examples

## Motivation

## Support

## API

## Contributing

## Background