# novaposhtarest

> Typings and functional interface for Nova Poshta (Нова Пошта) REST API

Latest version **0.1.2** (published 2023-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install novaposhtarest
pnpm add novaposhtarest
yarn add novaposhtarest
bun add novaposhtarest
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2023-05-16 |
| First published | 2023-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 139.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | maddsua |
| Maintainers | maddsua |
| Keywords | rest, typings, NovaPoshta, logistics |

## Links

- npm: https://www.npmjs.com/package/novaposhtarest
- Repository: https://github.com/maddsua/NovaPoshtaREST
- Homepage: https://github.com/maddsua/NovaPoshtaREST#readme
- Issues: https://github.com/maddsua/NovaPoshtaREST/issues
- npm.io page: https://npm.io/package/novaposhtarest

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.1

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.1.2 (latest) — 2023-05-16
- 0.1.0 — 2023-05-16

## README

# Typings and functional interface for Nova Poshta (Нова Пошта) REST API

This package provides typing and functions to call Nova Poshta api methods.

Currently supporting NodeJS in ESM mode and Deno. From the same npm package 🤘

Official API references are here: https://developers.novaposhta.ua/documentation

## Status

The package is in early stage and is not thoroughly tested. Bugs and inconsistencies may occur. Any contribution is appreciated.

## Submodules

Import them like this:

```typescript
import { getStatusDocuments } from 'novaposhtarest/TrackingDocument'
```

Submodules list:

<details>
	<summary>✅ Address</summary>
  
- ✅ searchSettlements
- ✅ searchSettlementStreets
- ✅ save
- ✅ delete
- ✅ update
- ✅ getSettlements
- ✅ getCities
- ✅ getAreas
- ✅ getWarehouses
- ✅ getWarehouseTypes
- ✅ getStreet
  
</details>

<details>
	<summary>✅ Counterparty</summary>
  
- ✅ save
- ✅ delete
- ✅ update
- ✅ getCounterpartyAddresses
- ✅ getCounterpartyOptions
- ✅ getCounterpartyContactPersons
- ✅ getCounterparties
  
</details>

<details>
	<summary>✅ ContactPerson</summary>
  
- ✅ save
- ✅ delete
- ✅ update
  
</details>

<details>
	<summary>✅ ScanSheet</summary>
  
- ✅ insertDocuments
- ✅ getScanSheet
- ✅ getScanSheetList
- ✅ deleteScanSheet
- ✅ removeDocuments
  
</details>

<details>
	<summary>✅ Common</summary>
  
- ✅ getTimeIntervals
- ✅ getCargoTypes
- ✅ getBackwardDeliveryCargoTypes
- ✅ getPalletsList
- ✅ getTypesOfPayersForRedelivery
- ✅ getPackList
- ✅ getTiresWheelsList
- ✅ getCargoDescriptionList
- ✅ getMessageCodeText
- ✅ getServiceTypes
- ✅ getOwnershipFormsList
  
</details>

<details>
	<summary>✅ AdditionalService</summary>
  
- ✅ CheckPossibilityCreateReturn
- ✅ getReturnReasons
- ✅ getReturnReasonsSubtypes
- ✅ orderCargoReturn
- ✅ getReturnOrdersList
- ✅ deleteAdditionalService
- ✅ CheckPossibilityChangeEW
- ✅ getChangeEWOrdersList
- ✅ checkPossibilityForRedirecting
- ✅ getRedirectionOrdersList
- ✅ getOwnershipFormsList
  
</details>

<details>
	<summary>✅ InternetDocument</summary>
  
- ✅ getDocumentPrice
- ✅ getDocumentDeliveryDate
- ✅ save
- ✅ update
- ✅ delete
- ✅ getDocumentList
- ✅ generateReport
  
</details>

<details>
	<summary>✅ TrackingDocument</summary>
  
- ✅ getStatusDocuments
  
</details>

## Compatibility

You can use this single package with NodeJS, Deno and Cloudflare Workers (not a runtime, but in this case it matters).

If you're building for NodeJS 18 and newer or CF Wrokers, use the normal import:

```typescript
import { getStatusDocuments } from 'novaposhtarest/TrackingDocument'
```

For older versions of Node that don't support the fetch API, use `compat` branch (just add `compat/` after the package name):

```typescript
import { getStatusDocuments } from 'novaposhtarest/compat/TrackingDocument'
```

And for the cool bois who use Deno, do it like this:

```typescript
import { getStatusDocuments } from './node_modules/novaposhtarest/dist/deno/models/TrackingDocument.ts'
```

Yeah, not very pretty but heeey

## Examples

Before running any examples, compile the project by running `tsc` or `npm run build` in it's root directory

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