connectwise-rest 1.0.0 → 1.1.0

package/.eslintrc

@@ -1,26 +1,23 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": "latest"
-  },
-  "plugins": ["@typescript-eslint", "prettier"],
-  "env": {
-    "node": true,
-    "mocha": true,
-    "es6": true
-  },
-  "extends": [
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended"
-  ],
-  "rules": {},
-  "ignorePatterns": [
-    "dist",
-    "src/AutomateTypes.js",
-    "src/ManageTypes.js"
-  ],
-  "settings": {
-
-  }
-}
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "plugins": ["@typescript-eslint", "prettier"],
+  "env": {
+    "node": true,
+    "mocha": true,
+    "es6": true
+  },
+  "extends": [
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "ignorePatterns": [
+    "dist",
+    "src/AutomateTypes.js",
+    "src/ManageTypes.js"
+  ],
+  "rules": {}
+}

package/README.md

@@ -1,15 +1,39 @@
 # connectwise-rest
 
- [![npm version](https://img.shields.io/npm/v/connectwise-rest.svg)](https://www.npmjs.com/package/connectwise-rest) [![npm downloads](https://img.shields.io/npm/dt/connectwise-rest.svg)](https://www.npmjs.com/package/connectwise-rest) [![travis build](https://api.travis-ci.org/covenanttechnologysolutions/connectwise-rest.svg?branch=master)](https://travis-ci.org/covenanttechnologysolutions/connectwise-rest)
+ [![npm version](https://img.shields.io/npm/v/connectwise-rest.svg)](https://www.npmjs.com/package/connectwise-rest) [![npm downloads](https://img.shields.io/npm/dt/connectwise-rest.svg)](https://www.npmjs.com/package/connectwise-rest) ![Node.js CI](https://github.com/covenanttechnologysolutions/connectwise-rest/actions/workflows/node.js.yml/badge.svg?branch=master)
 
-A Node.JS TypeScript module for interacting with the ConnectWise Manage and Automate REST APIs.  This module provides bindings for ease of development against the ConnectWise REST APIs. 
+A Node.JS TypeScript module for interacting with the ConnectWise Manage and Automate REST APIs. 
+This module provides bindings for ease of development against the ConnectWise REST APIs as well as pagination, automatic retries and logging.   
+
+###  ⚠️Breaking Changes ⚠️
+
+Version 1.0 has been completely re-written and is automatically generated, some function names have changed as well as removal of subsections from version 0.x.  Pagination API has been changed for easier usage.   VSCode, JetBrains, etc editors will automatically pick up the new type definitions.  
+
+## Table of Contents
+
+- [Requirements](#requirements)
+  - [Manage](#manage)
+  - [Automate](#automate)
+- [Documentation](#documentation)
+- [Usage](#usage)
+  - [Manage Usage](#manage-usage)
+  - [Automate Usage](#automate-usage)
+  - [Pagination](#pagination)
+  - [APIs Without Typings](#apis-without-typings)
+  - [Cloud-Hosted ConnectWise Manage](#cloud-hosted-connectwise-manage)
+- [Examples](#examples)
+  - [Sample Project](#sample-project)
+  - [Code Examples](#code-examples)
+  - [Manage Conditions Example](#manage-conditions-example)
+  - [Manage Callbacks](#manage-callbacks)
 
 ## Requirements
 
 ### Manage 
 
 - ConnectWise Manage 2018.1+, though these functions are written for ConnectWise Manage 2021.1 APIs.
-- ConnectWise Manage API keys (available on ConnectWise 2015.3+), or API Only Member keys (only available on ConnectWise 2015.6+).  See the [documentation](https://developer.connectwise.com/Authentication) for more details. 
+- ConnectWise Manage API keys (available on ConnectWise 2015.3+), or API Only Member keys (only available on ConnectWise 2015.6+).  See the [documentation](https://developer.connectwise.com/Authentication) for more details.
+
 ### Automate
 
 - ConnectWise Automate 2020+
@@ -17,17 +41,17 @@ A Node.JS TypeScript module for interacting with the ConnectWise Manage and Auto
 
 ## Documentation
 
-See the full documentation [here](https://covenanttechnologysolutions.github.io/connectwise-rest/index.html)
+See this package's full documentation [here](https://covenanttechnologysolutions.github.io/connectwise-rest/index.html)
 
 ## Usage
 
-### Manage
+### Manage Usage
 
 ```javascript
 // ESM
-import { AutomateAPI } from 'connectwise-rest';
+import { ManageAPI } from 'connectwise-rest';
 // CommonJS
-const { AutomateAPI } = require('connectwise-rest');
+const { ManageAPI } = require('connectwise-rest');
 
 const cwm = new ManageAPI({
   companyId: 'company',
@@ -43,7 +67,7 @@ const cwm = new ManageAPI({
     retries: 4,               // maximum number of retries
     minTimeout: 50,           // number of ms to wait between retries
     maxTimeout: 20000,        // maximum number of ms between retries
-    randomize: true,          // randomize timeouts
+    randomize: true,          // randomize delay between retries on timeouts
   },
   debug: false,               // optional, enable debug logging
   logger: (level, text, meta) => { } // optional, pass in logging function
@@ -59,7 +83,7 @@ cwm.ServiceDeskAPI.Tickets.getTicketById(1234)
 ```
 
 
-### Automate
+### Automate Usage
 
 ```javascript
 // ESM
@@ -67,16 +91,17 @@ import { AutomateAPI } from 'connectwise-rest';
 // CommonJS
 const { AutomateAPI } = require('connectwise-rest');
 
-const cwa = new ManageAPI({
+const cwa = new AutomateAPI({
   companyId: 'company',
   serverUrl: 'your.connectwise.com',
   clientId: '<your client id>',
-  // One of the following: token, integrator username and password or username, password and two-factor code
-  token: '<bearer token>',
-
-  // or integrator username/password:
+  // One of the following: integrator username and password or username, password and two-factor code
+  // integrator username/password:
   username: '<username>',
   password: '<private key>',
+  
+  // also pass in two factor passcode if not using an integrator account
+  // this is useful for command line utilities
   twoFactorPasscode: '<2fa code>',
 
   timeout: 20000,             // optional, request connection timeout in ms, defaults to 20000
@@ -85,7 +110,7 @@ const cwa = new ManageAPI({
     retries: 4,               // maximum number of retries
     minTimeout: 50,           // number of ms to wait between retries
     maxTimeout: 20000,        // maximum number of ms between retries
-    randomize: true,          // randomize timeouts
+    randomize: true,          // randomize delay between retries on timeouts
   },
   debug: false,               // optional, enable debug logging
   logger: (level, text, meta) => { } // optional, pass in logging function
@@ -100,6 +125,27 @@ cwa.ComputersAPI.getComputerList()
   });
 ```
 
+### Pagination
+
+Use the pagination function to automatically fetch all records in order that match the request.  
+
+Note: the last argument to the pagination function must be an object, or an error will be thrown.  
+
+```javascript
+const cwa = new ManageAPI()
+const cwm = new AutomateAPI()
+
+// use the instantiated ManageAPI or AutomateAPI
+cwm.paginate(
+  cwm.ServiceAPI.getServiceTickets,   // pass in the api function to be paginated
+  {startPage: 10, pageSize: 500},     // pagination options, defaults to startPage 1, pageSize 1000
+  {}                                  // additional arguments to the api function as needed                            
+)
+  .then(results => { /*...*/ })
+  .catch(error => { /*...*/ })
+
+```
+
 ### APIs Without Typings
 
 You can also manually access the API without typings:
@@ -153,6 +199,10 @@ To access cloud-hosted ConnectWise, use the `companyUrl` of `api-na.myconnectwis
 
 ## Examples
 
+### Sample Project
+
+See [the sample project here](https://github.com/k-grube/cw-micro).  This is a simple node.js express based API. 
+
 ### Code Examples
 
 Get ticket 1234 and print ticket number, summary and status. 
@@ -217,7 +267,7 @@ Error message returned from server when invalid conditions are passed in:
 > Expected a boolean value, not a numeric. String values should be enclosed with double or single quotes; DateTime values should be enclosed in square brackets; numbers should consist of only digits, and optionally a decimal point and a negation sign; boolean values should be indicated with the keywords true or false; null values should be indicated by the keyword null.
 
 
-### Callbacks
+### Manage Callbacks
 
 This library includes an express style callback middleware that will parse and verify the payload signature.
 
@@ -241,3 +291,4 @@ This library includes an express style callback middleware that will parse and v
   }));
 
 ```
+