@corellium/client-api v0.3.2

@corellium/client-api

CorelliumClient - JavaScript client for @corellium/client-api REST API to manage your virtual devices. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 4.5.0-16775
• Package version: 0.3.2
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @corellium/client-api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @corellium/client-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CorelliumClient = require('@corellium/client-api');

var defaultClient = CorelliumClient.ApiClient.instance;
// Configure Bearer (ApiToken or JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new CorelliumClient.CorelliumApi()
var projectId = "projectId_example"; // {String} Project ID - uuid
var projectKey = {
  "kind": "ssh",
  "label": "My New Key",
  "key": "ssh-ed25519 <key>"
}; // {ProjectKey} Key to add
api.v1AddProjectKey(projectId, projectKey).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://app.corellium.com/api

Documentation for Models

• CorelliumClient.Address
• CorelliumClient.AgentApp
• CorelliumClient.AgentAppReadyResponse
• CorelliumClient.AgentAppStatus
• CorelliumClient.AgentAppsList
• CorelliumClient.AgentAppsStatusList
• CorelliumClient.AgentError
• CorelliumClient.AgentIcons
• CorelliumClient.AgentInstallBody
• CorelliumClient.AgentProfilesReturn
• CorelliumClient.AgentSystemAdbAuth
• CorelliumClient.AgentSystemGetPropBody
• CorelliumClient.AgentValueReturn
• CorelliumClient.AgreedAck
• CorelliumClient.ApiConflictError
• CorelliumClient.ApiError
• CorelliumClient.ApiInternalConsistencyError
• CorelliumClient.ApiNotFoundError
• CorelliumClient.ApiToken
• CorelliumClient.Bit
• CorelliumClient.BtraceEnableOptions
• CorelliumClient.Button
• CorelliumClient.CouponOptions
• CorelliumClient.CreateTeam
• CorelliumClient.CreatedBy
• CorelliumClient.Credentials
• CorelliumClient.DomainOptions
• CorelliumClient.Extension
• CorelliumClient.Features
• CorelliumClient.FileChanges
• CorelliumClient.Firmware
• CorelliumClient.GpioStateDefinition
• CorelliumClient.GpiosState
• CorelliumClient.GrantTrialRequestResponse
• CorelliumClient.Hook
• CorelliumClient.Image
• CorelliumClient.Instance
• CorelliumClient.InstanceAgentState
• CorelliumClient.InstanceBootOptions
• CorelliumClient.InstanceBootOptionsAdditionalTag
• CorelliumClient.InstanceConsoleEndpoint
• CorelliumClient.InstanceCreateOptions
• CorelliumClient.InstanceInput
• CorelliumClient.InstanceNetdumpState
• CorelliumClient.InstanceNetmonState
• CorelliumClient.InstanceReturn
• CorelliumClient.InstanceServices
• CorelliumClient.InstanceStartOptions
• CorelliumClient.InstanceState
• CorelliumClient.InstanceStopOptions
• CorelliumClient.InstanceUpgradeBody
• CorelliumClient.Invitation
• CorelliumClient.InviteRevokeParams
• CorelliumClient.InviteRevokeParamsIds
• CorelliumClient.Kcrange
• CorelliumClient.KernelTask
• CorelliumClient.KernelThread
• CorelliumClient.MediaPlayBody
• CorelliumClient.Model
• CorelliumClient.ModelSoftware
• CorelliumClient.NetdumpFilter
• CorelliumClient.PasswordChangeBody
• CorelliumClient.PasswordResetBody
• CorelliumClient.PatchInstanceOptions
• CorelliumClient.PeripheralsData
• CorelliumClient.Plan
• CorelliumClient.Project
• CorelliumClient.ProjectKey
• CorelliumClient.ProjectQuota
• CorelliumClient.ProjectSettings
• CorelliumClient.ProjectUsage
• CorelliumClient.ProxyConfig
• CorelliumClient.RateInfo
• CorelliumClient.ResetLinkBody
• CorelliumClient.Role
• CorelliumClient.RotateBody
• CorelliumClient.Snapshot
• CorelliumClient.SnapshotCreationOptions
• CorelliumClient.SnapshotStatus
• CorelliumClient.SubscriberInvite
• CorelliumClient.Team
• CorelliumClient.TeamCreate
• CorelliumClient.TextInput
• CorelliumClient.Token
• CorelliumClient.TouchCurveInput
• CorelliumClient.TouchInput
• CorelliumClient.Trial
• CorelliumClient.TrialExtension
• CorelliumClient.TrialRequestMetadata
• CorelliumClient.TrialRequestOptions
• CorelliumClient.UpdateExtension
• CorelliumClient.User
• CorelliumClient.UserError
• CorelliumClient.V1CreateHookParameters
• CorelliumClient.V1LoadExtensionParameters
• CorelliumClient.V1SetStateBody
• CorelliumClient.ValidationError
• CorelliumClient.VolumeOptions
• CorelliumClient.VpnDefinition
• CorelliumClient.WebPlayerCreateSessionRequest
• CorelliumClient.WebPlayerSession

Documentation for Authorization

BearerAuth

• Type: Bearer authentication (ApiToken or JWT)