# uapi-jester

> Travelport Universal API Fork

Latest version **1.0.11** (published 2018-08-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install uapi-jester
pnpm add uapi-jester
yarn add uapi-jester
bun add uapi-jester
```

## 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.11 |
| Published | 2018-08-03 |
| First published | 2018-06-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 252.3 KB |
| Known vulnerabilities | 0 (+33 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mark Orel |
| Maintainers | dalper01, vancore295 |

## Links

- npm: https://www.npmjs.com/package/uapi-jester
- Repository: https://github.com/vancore295/uapi-json
- Homepage: https://github.com/Travelport-Ukraine/uapi-json#readme
- Issues: https://github.com/Travelport-Ukraine/uapi-json/issues
- npm.io page: https://npm.io/package/uapi-jester

## Dependencies (11)

- [joi](https://npm.io/package/joi.md) ^10.6.0
- [axios](https://npm.io/package/axios.md) ^0.15.3
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [moment](https://npm.io/package/moment.md) ^2.10.6
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.9
- [handlebars](https://npm.io/package/handlebars.md) ^4.0.5
- [pretty-data](https://npm.io/package/pretty-data.md) ^0.40.0
- [promise-retry](https://npm.io/package/promise-retry.md) ^1.1.1
- [galileo-screen](https://npm.io/package/galileo-screen.md) 1.0.5
- [node-errors-helpers](https://npm.io/package/node-errors-helpers.md) ^0.1.2
- [handlebars-helper-equal](https://npm.io/package/handlebars-helper-equal.md) ^1.0.0

## Recent versions

- 1.0.11 (latest) — 2018-08-03
- 1.0.10 — 2018-07-31
- 1.0.9 — 2018-07-30
- 1.0.8 — 2018-07-23
- 1.0.7 — 2018-06-20
- 1.0.6 — 2018-06-20
- 1.0.5 — 2018-06-18
- 1.0.4 — 2018-06-15
- 1.0.3 — 2018-06-14
- 1.0.2 — 2018-06-14
- 1.0.1 — 2018-06-14
- 1.0.0 — 2018-06-14

## README

# Description 
[![Build Status](https://travis-ci.org/Travelport-Ukraine/uapi-json.svg?branch=master)](https://travis-ci.org/Travelport-Ukraine/uapi-json)
[![Coverage](https://img.shields.io/codecov/c/github/Travelport-Ukraine/uapi-json/stable.svg)](https://codecov.io/gh/Travelport-Ukraine/uapi-json/branch/stable)
[![NPM](https://img.shields.io/npm/dt/uapi-json.svg)](https://www.npmjs.com/package/uapi-json)
[![Tag](https://img.shields.io/github/tag/Travelport-Ukraine/uapi-json.svg)](https://travis-ci.org/Travelport-Ukraine/uapi-json)

Best Travelport Universal API wrapper ever :airplane: :mountain_railway: :hotel:

Wrapper for [Travelport Universal API](https://developer.travelport.com/app/developer-network/universal-api).
Read [official docs](https://support.travelport.com/webhelp/uapi/uAPI.htm) for more information.

Travelport Universal API offers an array of travel content for air, hotel, car, and rail, including ancillaries (optional services). It also provides functionality to build complete traveler, agency, branch, and account profiles.

This package provides JSON/Promises interface for SOAP calls. Requires uAPI credentials to run.

# Contents

* [Installation](#installation)
* [Basic usage](#usage)
* [Settings](#settings)
* [Services](#services)

# Installation
<a name="installation"></a>

Install package with `npm install --save uapi-json`.

# Basic usage
<a name="usage"></a>

This package exports an object with three service constructors.

```javascript
const uAPI = require('uapi-json');

const AirService = uAPI.createAirService(settings);
const HotelService = uAPI.createHotelService(settings);
const UtilsService = uAPI.createUtilsService(settings);
const TerminalService = uAPI.createTerminalService(settings);
```

It also exports a set of error classes that help to check errors against them

```javascript
const uAPI = require('uapi-json');

const settings = { auth: {username: 'USERNAME', password: 'PASSWORD'}};
const AirService = uAPI.createAirService(settings);

AirService.importPNR().catch((err) => {
  if (err instanceof uAPI.errors.Common.ValidationError) {
    console.log('Validation error occured');
  }
  if (err instanceof uAPI.errors.Request.RequestValidationError) {
    console.log('Validation error occured in request');
  }
  if (err instanceof uAPI.errors.Request.RequestValidationError.ParamsMissing) {
    console.log('Params are missing for request');
  }
});
```

As [`node-errors-helpers`](https://github.com/Travelport-Ukraine/errors-helpers) library
is used for errors generating, we strongly reccomend you to tak a look at it.
It also has several useful helpers to handle errors.

# Settings
<a name="settings"></a>

## uAPI
* `.createAirService(settings)` ⇒ [`AirService`](docs/Air.md)
* `.createHotelService(settings)`  ⇒ [`HotelService`](docs/Hotels.md)
* `.createUtilsService(settings)` ⇒ [`UtilsService`](docs/Utils.md)
* `.createTerminalService(settings)` ⇒ [`TerminalService`](docs/Terminal.md)

### Settings object

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| auth | `Object <username, password, targetBranch, emulatePcc>` | - | See `auth` description [below](#auth). |
| debug | `Number` | `0` | Can be `0`, `1`, or `2`. |
| production | `Boolean` | `true` | Production variable is connected with production and pre-production environment. Can be true for production and false for pre-production. For more information read docs. |
| timeout | `Number` | - | Optional. Used for `TerminalService` only. See [`TerminalService`](docs/Terminal.md) |
| autoClose | `Boolean` | Optional. Used only in `TerminalService`. Defines if service should make `closeSession` request. |
| options | `Object` | {} | Optional. User for all services to all additional options like custom log function, etc. See `options` description [bellow](#options). |

<a name="options"></a>
### Additional options 

`logFunction` - set custom logging function that should match next shape `(...args) => {}`. Will receive all requests and responses from uapi/terminal.

### Auth object
<a name="auth"></a>
`username`, `password` and `targetBranch` should be set in `auth` object and are provided by Travelport.
Optional `emulatePcc` is a PCC on behalf of which transactions are executed.
This PCC needs to have set SVCB field in the AAT profile.

There are 3 types of `debug` mode:

* `debug=0` - disabled any logs.
* `debug=1` - logging only request params, request xml and error if it's occurred.
* `debug=2` - same as 1 but also logging all response xml (due to lot of text to log).
* `debug=3` - logs everything.

# Services
<a name="services"></a>
See the following services pages to take a detailed view
* [`AirService`](docs/Air.md)
* [`HotelService`](docs/Hotels.md)
* [`UtilsService`](docs/Utils.md)
* [`TerminalService`](docs/Terminal.md)


# Contributing
Please visit [CONTRIBUTING.md](/CONTRIBUTING.md)

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