@arm-avh/avh-api v1.0.2

@arm-avh/avh-api

AvhApi - JavaScript client for @arm-avh/avh-api

This documents the Arm Virtual Hosting REST API. For other examples and API clients such as python or javascript please see API Clients (python/javascript). For a guide on using this interface please see API Quickstart

Links

• API Quickstart

• API Clients (python/javascript)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3.15.0-15704
• Package version: 1.0.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 @arm-avh/avh-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 @arm-avh/avh-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 AvhApi = require('@arm-avh/avh-api');


var api = new AvhApi.ArmApi()
var trialEmail = "trialEmail_example"; // {String} Trial Email
api.trialStatus(trialEmail).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.avh.arm.com/api

Documentation for Models

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

Documentation for Authorization

BearerAuth

• Type: Bearer authentication (ApiToken or JWT)