@ramonornela/pro-api-javascript-client

A simple JasvaScript client for interacting with Ionic Pro


Keywords
typescript, javascript, ionic
License
MIT
Install
npm install @ramonornela/pro-api-javascript-client@0.0.13-0

Documentation

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 is actually what you want.

Alpha Notice

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

Available API Resources

  • Apps
  • Snapshots (JS Builds)
  • Packages (Native Builds)
  • Users
  • Deploy channels
  • Organizations
  • Teams
  • View Testers

Installation

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

Usage

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);
});