# status-exchange-mgo

> Status Messages for My Gateway Oxxo

Latest version **0.0.3** (published 2018-10-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install status-exchange-mgo
pnpm add status-exchange-mgo
yarn add status-exchange-mgo
bun add status-exchange-mgo
```

## 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.0.3 |
| Published | 2018-10-23 |
| First published | 2018-09-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.8 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Abraham Silva |
| Maintainers | abrahamjso |
| Keywords | mgo, oxxo, statusexchange |

## Links

- npm: https://www.npmjs.com/package/status-exchange-mgo
- Repository: https://github.com/abrahamjso/status-exchange-mgo
- Homepage: https://github.com/abrahamjso/status-exchange-mgo#readme
- Issues: https://github.com/abrahamjso/status-exchange-mgo/issues
- npm.io page: https://npm.io/package/status-exchange-mgo

## Dependencies (1)

- [mongoose](https://npm.io/package/mongoose.md) ^5.2.17

## Recent versions

- 0.0.3 (latest) — 2018-10-23
- 0.0.2 — 2018-09-25
- 0.0.1 — 2018-09-25

## README

# status-exchange-mgo

status-exchange-mgo is a utility for My Gateway Oxxo, driving status exchanges between differents states or transactions.
The library is composed by two utilities, **statusExchange** and **statusExchangeCodes**.

```js
const SE = require('status-exchange-mgo');

const statusExchange = SE.statusExchange({ urlConnection: '<mongoUriConnetion>'})
const statusExchangeCodes = SE.statusExchangeCodes;
...
```

# Install

```console
$ npm install status-exchange-mgo
```

# Methods

### statusExchange
```js
var SE = require('status-exchange-mgo');

// statusExchange
const statusExchange = SE.statusExchange({ urlConnetion: '<mongoUriConnetion>'});
```

 - initTransaction(**transactionID: string**)
 - transactionBackupJSON(**transactionID: string**, **jsonURL: string**)
 - transactionTransformedToTNFormat(**transactionID: string**)
 - transactionBackupXML(**transactionID: string**, **xmlURL: string**)
 - transactionSentToTN(**transactionID: string**)
 - getStatusByTransactionID(**transactionID: string**)

### statusExchangeCodes
```js
var SE = require('status-exchange-mgo');

// statusExchange
const statusExchangeCodes = SE.statusExchangeCodes;
```

```js
EX0010: { statusCode:  'EX0010', message:  'Receive a new Transaction' },
EX1010: { statusCode:  'EX1010', message:  'The Transaction was transformed' },
EX3010: { statusCode:  'EX3010', message:  'The Transaction was backed JSON' },
EX3020: { statusCode:  'EX3020', message:  'The Transaction was backed XML' },
EX5010: { statusCode:  'EX5010', message:  'The Transaction started send to TN' },
EX5200: { statusCode:  'EX5200', message:  'The Transaction sent to TN was success' },
EX5040: { statusCode:  'EX5400', message:  'The Transaction sent to TN was failed' },
customStatus: (statusCode  =  null, message  =  null) => { return { statusCode, message }; },
```

# Contribute

If there is a new model you would like to support, or want to add a direct conversion between two existing models, please send us a pull request.

# License
Copyright &copy; 2018, Abraham Silva. Licensed under the [ISC License](LICENSE).

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