Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@al/policies

alertlogic38MIT2.0.7TypeScript support: included

A client for interacting with the Alert Logic Policies Public API

Alert Logic, Client, Service

readme

@alertlogic/policies

A client for working with the Policies Alert Logic API.

This library uses @alertlogic/policies as its HTTP provider interface.

Disclaimer

Until the release of version 1.0.0 all current minor version increments may be backwards incompatible. Please bear this in mind when developing against this library. Should you have any further questions, please do not hesitate to contact us as npm@alertlogic.com

Installation

  npm install @alertlogic/policies --save

Usage

  var PoliciesClient = require('@alertlogic/policies').PoliciesClient; //commonjs - e.g. node
  import { PoliciesClient } from '@alertlogic/policies'; //ES2015 - e.g. Angular, TS projects

Get Policy

PoliciesClient.getPolicy(accountId, poilicyId)
  accountId: '1234'
  poilicyId: '1234'

List Policies

PoliciesClient.listPolicies(accountId)
  accountId: '1234'

Interactive

Loads the library into memory and stays in an interactive node shell.

  npm run interactive

NOTE - You must build the sources before running this command, see Building section below

Tests

  npm test

Contributing

The sources are written in Typescript and follow the tslint airbnb style.

Building

To generate a production build

npm run build

To generate a development build

npm run build-dev

Builds will be be generated into a dist folder and will contain commonjs and umd bundles that will be consumed depending on the module system in whichever environment you are using.