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 🙏

© 2025 – Pkg Stats / Ryan Hefner

@b-jones-rfd/nice-api-tasks

v0.2.0

Published

Perform common tasks using the Nice InContact API

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

b-jones-rfdb-jones-rfd

Keywords

Readme

GitHub Actions CI npm version npm bundle size code style: prettier

Nice API Tasks

Helpers to perform common tasks using the Nice InContact API. This is an exercise to avoid code reuse in my own projects. Use at your own risk.

Prerequisites

This project requires NodeJS (version >= 18) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
10.2.4
v20.11.1

PNPM is a awesome alternative to NPM and is recommended.

Table of contents

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install and set up the library, run:

$ npm i @b-jones-rfd/nice-api-tasks

Or if you prefer using Yarn:

$ yarn add @b-jones-rfd/nice-api-tasks

Or for PNPM:

$ pnpm add @b-jones-rfd/nice-api-tasks

Usage

TBD

API

Authentication

getToken(options)

Implements OAuth Authentication (Post Authentication) and returns the access token as the result data.

options

| Property | Type | Description | Required | | ------------ | ------ | -------------------- | -------- | | clientId | string | Nice Client ID | Y | | clientSecret | string | Nice Client Password | Y | | username | string | Nice Access Key | Y | | password | string | Nice Access Secret | Y |

Extracts

getExtractData(options)

Implements Data Extraction and returns the extract text. For available extracts review Data Extraction APIs online help. This is a multistep process running the following actions:

  1. Start data extract
  2. Polls Get data extract status until error or complete
  3. Returns the file text as string

options

| Property | Type | Description | Format | Required | | ----------- | ------ | ------------------- | ---------- | -------- | | entityName | string | Extract entity name | | Y | | version | string | Extract version | | Y | | startDate | string | Extract start date | YYYY-MM-DD | Y | | endDate | string | Extract end date | YYYY-MM-DD | Y | | accessToken | string | Bearer token | | Y |

getExtractStatus(options)

Implements Data Extraction (Get a specific job status) and returns the status of the job. For available extracts review Data Extraction APIs online help.

options

| Property | Type | Description | Required | | ----------- | ------ | ------------ | -------- | | jobId | string | Job ID | Y | | accessToken | string | Bearer token | Y |

runExtracts(options)

Implements Data Extraction and returns the status of the completed job. For available extracts review Data Extraction APIs online help. This is a multistep process running the following actions:

  1. Start data extract
  2. Polls Get data extract status until error or complete

options

| Property | Type | Description | Format | Required | | ----------- | ------ | ------------------- | ---------- | -------- | | entityName | string | Extract entity name | | Y | | version | string | Extract version | | Y | | startDate | string | Extract start date | YYYY-MM-DD | Y | | endDate | string | Extract end date | YYYY-MM-DD | Y | | accessToken | string | Bearer token | | Y |

startExtract(options)

Implements Data Extraction (Prepares data for extraction) and returns the job id as the result data. For available extracts review Data Extraction APIs online help.

options

| Property | Type | Description | Format | Required | | ----------- | ------ | ------------------- | ---------- | -------- | | entityName | string | Extract entity name | | Y | | version | string | Extract version | | Y | | startDate | string | Extract start date | YYYY-MM-DD | Y | | endDate | string | Extract end date | YYYY-MM-DD | Y | | accessToken | string | Bearer token | | Y |

Contributing

This is a pet project to save me time at work. It is still under development and you should use at your own risk.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

MIT License