# ups-brazil-js

> 💵 UPS Brazil Javascript API Client for calculate quote

Latest version **2.1.0** (published 2020-07-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install ups-brazil-js
pnpm add ups-brazil-js
yarn add ups-brazil-js
bun add ups-brazil-js
```

## 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 | 2.1.0 |
| Published | 2020-07-28 |
| First published | 2020-07-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 31.8 KB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jonathan Célio |
| Maintainers | jonycelio |
| Keywords | ups brazil, ups, ups brasil |

## Links

- npm: https://www.npmjs.com/package/ups-brazil-js
- Repository: https://github.com/jonyw4/ups-brazil-js
- Homepage: https://github.com/jonyw4/ups-brazil-js#readme
- Issues: https://github.com/jonyw4/ups-brazil-js/issues
- npm.io page: https://npm.io/package/ups-brazil-js

## Dependencies (5)

- [xml](https://npm.io/package/xml.md) ^1.0.1
- [axios](https://npm.io/package/axios.md) ^0.19.2
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.23
- [@types/xml](https://npm.io/package/@types/xml.md) ^1.0.5
- [@types/xml2js](https://npm.io/package/@types/xml2js.md) ^0.4.5

## Recent versions

- 2.1.0 (latest) — 2020-07-28
- 2.0.0 — 2020-07-07
- 1.1.7 — 2020-07-02

## README

# UPS Brazil Javascript API Client

[![npm (scoped)](https://img.shields.io/npm/v/ups-brazil-js.svg)](https://www.npmjs.com/package/ups-brazil-js)
![Build Status](https://github.com/jonyw4/ups-brazil-js/workflows/Test,%20build%20and%20deploy/badge.svg)
[![codecov](https://codecov.io/gh/jonyw4/ups-brazil-js/branch/master/graph/badge.svg)](https://codecov.io/gh/jonyw4/ups-brazil-js)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

A JavaScript library to interface UPS Brazil API for calculate quote, it works in the browser and with Node.js. The [documentation can be found here](https://jonyw4.github.io/ups-brazil-js/).

## 📖 How to use?
Install the library
```bash
npm i ups-brazil-js
```

Import the library
```typescript
import upsBrazil from 'ups-brazil-js';

const response = await upsBrazil(user,
  password,
  originZipCode,
  destinationZipCode,
  packageData,
  invoiceValue,
  timeout
);
```

## 😍 Do you like?
*Please, consider supporting my work as a lot of effort takes place to create this component! Thanks a lot.*

<a href="https://www.buymeacoffee.com/jonycelio" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-yellow.png" alt="Buy Me A Coffee" style="height: 51px !important;width: 217px !important;" ></a>

## 📚 API Docs

This library provides a promise based interface for all functions. Before you
can use the library, you need to provide authentication details which will be
used through API calls.

For a detailed documentation, see our [Documentation](https://jonyw4.github.io/ups-brazil-js/)

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