# @ionic/pro-api-javascript-client

> A simple JasvaScript client for interacting with Ionic Pro

Latest version **0.0.13** (published 2017-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ionic/pro-api-javascript-client
pnpm add @ionic/pro-api-javascript-client
yarn add @ionic/pro-api-javascript-client
bun add @ionic/pro-api-javascript-client
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.13 |
| Published | 2017-11-07 |
| First published | 2017-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ionic |
| Maintainers | fuiste, manucorporat, jgw96, jthoms1, nhyatt, brandyscarney, mhartington, danbucholtz, adamdbradley, maxlynch, dwieeb, drifty, ionicjs |
| Keywords | typescript, javascript, ionic |

## Links

- npm: https://www.npmjs.com/package/@ionic/pro-api-javascript-client
- Repository: https://github.com/ionic-team/pro-sdk
- Homepage: https://github.com/ionic-team/pro-sdk#readme
- Issues: https://github.com/ionic-team/pro-sdk/issues
- npm.io page: https://npm.io/package/@ionic/pro-api-javascript-client

## Dependencies (3)

- [superagent](https://npm.io/package/superagent.md) ^3.6.3
- [typescript](https://npm.io/package/typescript.md) ^2.5.3
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.1.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.13 (latest) — 2017-11-07
- 0.0.12 — 2017-11-07
- 0.0.11 — 2017-11-07
- 0.0.9 — 2017-10-18
- 0.0.8 — 2017-10-18
- 0.0.7 — 2017-10-18
- 0.0.6 — 2017-10-18
- 0.0.5 — 2017-10-18

## README

# Ionic Pro API Client

A simple JavaScript client for interacting with the Ionic Pro API.

Note: this is meant for API access, not end-user apps. For most users, the [Pro Client](https://www.npmjs.com/package/@ionic/pro) is actually what you want.

## Alpha Notice

This is still in active development, and is far from comprehensive at the moment.  

### Available API Resources

- [x] Apps
- [x] Snapshots (JS Builds)
- [x] Packages (Native Builds)
- [x] Users
- [ ] Deploy channels
- [ ] Organizations
- [ ] Teams
- [ ] View Testers

## Installation

```bash
npm install --save @ionic/pro-api-javascript-client
```

## Usage

```typescript
import { Environment, ProClient, User } from 'pro-client';

...

// Instantiate the client
let cfg: Environment = { debug: true }
let client: ProClient = new ProClient(cfg);

...

// Login to Ionic Pro
client.login("username@test.com", "myAwesomePassword123").then((user: User) => {
  console.log("Logged in", user);
});

...

// List apps you have access to
client.resource.apps.list().then((res: any) => {
  console.log("My apps:", res);
}, (err: any) => {
  console.error("Error getting apps:", err);
});

...

// List native builds for an app
let appId: string = "abcd1234";
let filters = { platform: "iOS" }; // Optional

client.resource.package.list(appId, filters).then((res: any) => {
  console.log("My native builds:", res);
}, (err: any) => {
  console.error("Error getting builds:", err);
});
```

---
_Source: https://npm.io/package/@ionic/pro-api-javascript-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._