npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2021 – Pkg Stats / Ryan Hefner

victorops-api-client

v1.0.2

Published

A library for interacting with the VictorOps REST API

Downloads

7,343

Readme

VictorOps API Client GitHub package.json version Build Status Coverage Status codecov

The victorops-api-client library contains a simple and convenient HTTP client for making requests to the VictorOps REST API.

Table of contents

Installation

Using NPM:

$ npm install victorops-api-client

Using Yarn:

$ yarn add victorops-api-client

Usage

Initialize the client

The library exports a VictorOpsApiClient class. All you need to do is instantiate it, and you're ready to go. You'll need an API ID and API key provided by VictorOps. You can provide these values as apiId and apiKey options or set these values as environment variables using VO_API_ID and VO_API_KEY. By default, the client will use the VO_API_ID and VO_API_KEY environment variables if apiId and apiKey are not provided in the options.

Example import methods:

const VictorOpsApiClient = require('victorops-api-client');

const client = new VictorOpsApiClient({
  apiId: 'API-ID',
  apiKey: 'API-KEY'
});
import VictorOpsApiClient from 'victorops-api-client';

const client = new VictorOpsApiClient({
  apiId: 'API-ID',
  apiKey: 'API-KEY'
});

It is required to set the API ID and API key parameters as either environment variables or as options when instantiating the client. These parameters are necessary to execute VictorOpsApiClient calls. If these parameters are not provided or cannot be determined, then an error is thrown.

Using environment variables in an application:

const VictorOpsApiClient = require('victorops-api-client');

// Set the API ID and key as environment variables.
process.env.VO_API_ID = 'SOME-API-ID';
process.env.VO_API_KEY = 'SOME-API-KEY';

const client = new VictorOpsApiClient();

Setting environment variables before running an application:

Linux:

$ VO_API_ID=SOME-API-ID VO_API_KEY=SOME-API-KEY node app.js

Windows:

> cmd /C "set VO_API_ID=SOME-API-ID && set VO_API_KEY=SOME-API-KEY && node app.js"

Options

These are the available options for creating a VictorOpsApiClient instance. If the apiId and apiKey options are not provided, then the VO_API_ID and VO_API_KEY environment variables will be used instead.

| Name | Default | Description | | ------------------- | ---------------------------- | --------------------------------------------------------- | | apiId | undefined | VictorOps API ID |
| apiKey | undefined | VictorOps API Key | | timeout | 5000 | Number of milliseconds before the request times out | | baseUrl | https://api.victorops.com | The base URL for the VictorOps REST API | | fullResponse | false | Get the full response instead of just the body | | maxContentLength | 10000 | The max size of the HTTP response content in bytes | | maxBodyLength | 2000 | The max allowed size of the HTTP request body in bytes |

Examples

Create an instance:

const VictorOpsApiClient = require('victorops-api-client');

const client = new VictorOpsApiClient({
  apiId: 'API-ID',
  apiKey: 'API-KEY'
});

Get a list of users:

async function getUsers() {
  try {
    const users = await client.users.getUsers();
    return users;
  } catch(err) {
    console.error(err);
  }
}

Get a list of incidents:

async function getIncidents() {
  try {
    const incidents = await client.incidents.getIncidents();
    return incidents;
  } catch(err) {
    console.error(err);
  }
}

Create a new incident:

async function createIncident() {
  try {
    const resp = await client.incidents.createIncident({
      summary: 'Test incident',
      details: 'Something bad happened!!!',
      userName: 'johndoe',
      targets: [
        {
          type: 'User',
          slug: 'johndoe'
        }
      ],
      isMultiResponder: true
    });
    return resp;
  } catch(err) {
    console.error(err);
  }
}

Get a list of teams:

async function getTeams() {
  try {
    const teams = await client.teams.getTeams();
    return teams;
  } catch(err) {
    console.error(err);
  }
}

Documentation

The client instance has a named property for each of the public endpoints in the VictorOps REST API. Each endpoint property contains methods that correspond to the operations associated with the endpoint (according to the VictorOps API). All named endpoint methods return a Promise which resolves with the response data or rejects with an error. Below are the endpoints and operations included with the client.

Any endpoint operation that takes a query argument expects the value to be an Object that contains the query parameters for that particular endpoint operation. Please refer to the endpoint operation's documentation for the correct query parameters.

On-Call

Incidents

Alerts

Reporting

Users

User Contact Methods

  • client.contactMethods.getContactMethods(user) - Get a list of all contact methods for a user - VictorOps Documentation
  • client.contactMethods.getContactDevices(user) - Get a list of all contact devices for a user - VictorOps Documentation
  • client.contactMethods.deleteContactDevice(user, contactId) - Delete a contact device for a user - VictorOps Documentation
  • client.contactMethods.getContactDevice(user, contactId) - Get the indicated contact device for a user - VictorOps Documentation
  • client.contactMethods.updateContactDevice(user, contactId, contactDevice) - Update a contact device for a user - VictorOps Documentation
  • client.contactMethods.getContactEmails(user) - Get a list of all contact emails for a user - VictorOps Documentation
  • client.contactMethods.createContactEmail(user, contactEmail) - Create a contact email for a user - VictorOps Documentation
  • client.contactMethods.deleteContactEmail(user, contactId) - Delete a contact email for a user - VictorOps Documentation
  • client.contactMethods.getContactEmail(user, contactId) - Get a contact email for a user - VictorOps Documentation
  • client.contactMethods.getContactPhones(user) - Get a list of all contact phones for a user - VictorOps Documentation
  • client.contactMethods.createContactPhone(user, contactPhone) - Create a contact phone for a user - VictorOps Documentation
  • client.contactMethods.deleteContactPhone(user, contactId) - Delete a contact phone for a user - VictorOps Documentation
  • client.contactMethods.getContactPhone(user, contactId) - Get a contact phone for a user - VictorOps Documentation

User Paging Policies

Personal Paging Policy Values

Personal Paging Policies

  • client.personalPagingPolicies.getPagingPolicy(username) - Get a user's paging policy - VictorOps Documentation
  • client.personalPagingPolicies.createPolicyStep(username, stepInfo) - Create a paging policy step - VictorOps Documentation
  • client.personalPagingPolicies.getPolicyStep(username, step) - Get a paging policy step - VictorOps Documentation
  • client.personalPagingPolicies.createPolicyStepRule(username, step, ruleInfo) - Creates a rule for a paging policy step. - VictorOps Documentation
  • client.personalPagingPolicies.updatePolicyStep(username, step, stepInfo) - Updates a paging policy step - VictorOps Documentation
  • client.personalPagingPolicies.deletePolicyStepRule(username, step, rule) - Deletes a rule for a paging policy step - VictorOps Documentation
  • client.personalPagingPolicies.getPolicyStepRule(username, step, rule) - Gets a rule for a paging policy step - VictorOps Documentation
  • client.personalPagingPolicies.updatePolicyStepRule(username, step, rule, ruleInfo) - Updates a rule for a paging policy step - VictorOps Documentation

Teams

Escalation Policies

Routing Keys

  • client.routingKeys.getRoutingKeys() - List routing keys and associated teams - VictorOps Documentation
  • client.routingKeys.createRoutingKey(keyInfo) - Create a new routing key with escalation policy mapping - VictorOps Documentation

Scheduled Overrides

  • client.scheduledOverrides.getOverrides() - List all the scheduled overrides for an organization - VictorOps Documentation
  • client.scheduledOverrides.createOverride(overrideInfo) - Create a new scheduled override - VictorOps Documentation
  • client.scheduledOverrides.deleteOverride(publicId) - Deletes a scheduled override - VictorOps Documentation
  • client.scheduledOverrides.getOverride(publicId) - Get the specified scheduled override - VictorOps Documentation
  • client.scheduledOverrides.getAssignments(publicId) - Get the specified scheduled override assignments - VictorOps Documentation
  • client.scheduledOverrides.deleteAssignment(publicId, policySlug) - Delete a scheduled override assignment - VictorOps Documentation
  • client.scheduledOverrides.getAssignment(publicId, policySlug) - Get the specified scheduled override assignments - VictorOps Documentation
  • client.scheduledOverrides.updateAssignment(publicId, policySlug, assignmentInfo) - Update a scheduled override assignment - VictorOps Documentation

Rotations

Webhooks

Chat

Notes

Maintenance Mode

Change Log

The CHANGELOG contains descriptions of notable changes.

License

This software is licensed under the Apache 2 license.