connectwise-rest 1.0.1 → 1.2.1

package/.eslintignore

@@ -1 +0,0 @@
-scratch

package/LICENSE.md

@@ -1,7 +1,7 @@
-Copyright (c) 2015 Kevin Grube
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2015-2022 Kevin Grube
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -41,7 +41,7 @@ Version 1.0 has been completely re-written and is automatically generated, some
 
 ## 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
 
@@ -49,9 +49,9 @@ See the full documentation [here](https://covenanttechnologysolutions.github.io/
 
 ```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',
@@ -91,7 +91,7 @@ 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>',
@@ -101,6 +101,7 @@ const cwa = new ManageAPI({
   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
@@ -140,8 +141,8 @@ cwm.paginate(
   {startPage: 10, pageSize: 500},     // pagination options, defaults to startPage 1, pageSize 1000
   {}                                  // additional arguments to the api function as needed                            
 )
-  .then(results => { ... })
-  .catch(error => { ... })
+  .then(results => { /*...*/ })
+  .catch(error => { /*...*/ })
 
 ```
 
@@ -151,10 +152,10 @@ You can also manually access the API without typings:
 
 ```javascript
 
-    const { Manage, Automate } = require('connectwise-rest');
+    const { ManageAPI, AutomateAPI } = require('connectwise-rest');
 
-    const cwm = new Manage(CWMOptions);
-    const cwa = new Automate(CWAOptions);
+    const cwm = new ManageAPI(CWMOptions);
+    const cwa = new AutomateAPI(CWAOptions);
     
     // use cwa.request or cwm.request
     cwm.request({

package/dist/Automate.d.ts

@@ -1,6 +1,7 @@
 import { CWLogger, RequestOptions, RetryOptions } from './types';
 import { CWAOptions } from './AutomateAPI';
 import { components } from './AutomateTypes';
+import { PaginationApiMethod, PaginationOptions } from './BaseAPI';
 declare type schemas = components['schemas'];
 declare type TokenResult = schemas['Automate.Api.Domain.Contracts.Security.TokenResult'];
 export declare const DEFAULTS: {
@@ -23,6 +24,18 @@ export default class Automate {
      * @public
      */
     request: (args: RequestOptions) => Promise<any>;
+    /**
+     * @public
+     * Pass the function to be paginated first, then arguments to paginate itself,
+     * then any additional arguments to the function in order
+     *
+     * @example
+     * ```javascript
+     *  cwa.paginate(cwa.ComputersAPI.getComputerList, {startPage: 1, pageSize: 1000}, {conditions: 'inactiveFlag = false'})
+     *
+     * ```
+     */
+    paginate: (apiMethod: PaginationApiMethod, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>;
     constructor({ serverUrl, username, password, twoFactorPasscode, token, clientId, timeout, retry, retryOptions, logger, debug, }: CWAOptions);
     get token(): string | undefined;
     set token(token: string | undefined);

package/dist/Automate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Automate.d.ts","sourceRoot":"","sources":["../src/Automate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAA+B,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,aAAK,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;AACpC,aAAK,WAAW,GAAG,OAAO,CAAC,oDAAoD,CAAC,CAAA;AAIhF,eAAO,MAAM,QAAQ,EAAE;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,YAAY,CAAA;IAC1B,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,QAAQ,CAAA;CAgCrC,CAAA;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,MAAM,EAAE,QAAQ,CAAA;IAChB,KAAK,EAAE,OAAO,CAAA;IACd,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,MAAM,EAAE,cAAc,CAAA;IACtB,OAAO,CAAC,QAAQ,CAAe;IAC/B;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;gBAEnC,EACV,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,QAAQ,EACR,OAAe,EACf,KAAa,EACb,YAAoC,EACpC,MAAM,EACN,KAAK,GACN,EAAE,UAAU;IAsCb,IAAI,KAAK,uBAER;IAED,IAAI,KAAK,CAAC,KAAK,oBAAA,EAEd;WAEY,QAAQ,CAAC,EACpB,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,SAAS,GACV,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,iBAAiB,CAAC,EAAE,MAAM,CAAA;QAC1B,SAAS,EAAE,MAAM,CAAA;KAClB,GAAG,OAAO,CAAC,WAAW,CAAC;IAUlB,WAAW;IASjB;;OAEG;YACW,GAAG;IAoCjB,OAAO,CAAC,mBAAmB;CAa5B"}
+{"version":3,"file":"Automate.d.ts","sourceRoot":"","sources":["../src/Automate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAA+B,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAA6B,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAC7F,aAAK,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;AACpC,aAAK,WAAW,GAAG,OAAO,CAAC,oDAAoD,CAAC,CAAA;AAIhF,eAAO,MAAM,QAAQ,EAAE;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,YAAY,CAAA;IAC1B,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,QAAQ,CAAA;CAgCrC,CAAA;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,MAAM,EAAE,QAAQ,CAAA;IAChB,KAAK,EAAE,OAAO,CAAA;IACd,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,MAAM,EAAE,cAAc,CAAA;IACtB,OAAO,CAAC,QAAQ,CAAe;IAC/B;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAE/C;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,CACR,SAAS,EAAE,mBAAmB,EAC9B,YAAY,EAAE,iBAAiB,EAC/B,GAAG,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KACrC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;gBAEX,EACV,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,QAAQ,EACR,OAAe,EACf,KAAa,EACb,YAAoC,EACpC,MAAM,EACN,KAAK,GACN,EAAE,UAAU;IAuCb,IAAI,KAAK,uBAER;IAED,IAAI,KAAK,CAAC,KAAK,oBAAA,EAEd;WAEY,QAAQ,CAAC,EACpB,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,SAAS,GACV,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,iBAAiB,CAAC,EAAE,MAAM,CAAA;QAC1B,SAAS,EAAE,MAAM,CAAA;KAClB,GAAG,OAAO,CAAC,WAAW,CAAC;IAUlB,WAAW;IASjB;;OAEG;YACW,GAAG;IAoCjB,OAAO,CAAC,mBAAmB;CAa5B"}

package/dist/Automate.js

@@ -63,6 +63,23 @@ class Automate {
             writable: true,
             value: void 0
         });
+        /**
+         * @public
+         * Pass the function to be paginated first, then arguments to paginate itself,
+         * then any additional arguments to the function in order
+         *
+         * @example
+         * ```javascript
+         *  cwa.paginate(cwa.ComputersAPI.getComputerList, {startPage: 1, pageSize: 1000}, {conditions: 'inactiveFlag = false'})
+         *
+         * ```
+         */
+        Object.defineProperty(this, "paginate", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         if (token && username && password) {
             throw new Error('Authenticate with token or username and password only, do not pass both methods');
         }
@@ -90,6 +107,7 @@ class Automate {
             this.createAxiosInstance();
         }
         this.request = (0, BaseAPI_1.makeRequest)({ config: this.config, api: this.api, thisObj: this });
+        this.paginate = (0, BaseAPI_1.makePaginate)({ thisObj: this });
     }
     get token() {
         return this.config.token;
@@ -135,8 +153,8 @@ class Automate {
             return result === null || result === void 0 ? void 0 : result.data;
         }
         catch (error) {
-            if (error.isAxiosError()) {
-                return {
+            if (error.isAxiosError) {
+                throw {
                     status: (_a = error.response) === null || _a === void 0 ? void 0 : _a.status,
                     data: (_b = error.response) === null || _b === void 0 ? void 0 : _b.data,
                     message: error === null || error === void 0 ? void 0 : error.message,

package/dist/Automate.js.map

@@ -1 +1 @@
-{"version":3,"file":"Automate.js","sourceRoot":"","sources":["../src/Automate.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAwD;AAIxD,uCAAuC;AAIvC,MAAM,iBAAiB,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;AAE5C,QAAA,QAAQ,GAIjB;IACF,UAAU,EAAE,KAAK;IACjB,YAAY,EAAE;QACZ,OAAO,EAAE,CAAC;QACV,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,KAAK;QACjB,SAAS,EAAE,IAAI;KAChB;IACD,MAAM,EACJ,CAAC,KAAK,GAAG,KAAK,EAAE,EAAE,CAClB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACpB,QAAQ,KAAK,EAAE;YACb,KAAK,OAAO;gBACV,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;gBACxC,OAAM;YACR,KAAK,MAAM;gBACT,IAAI,KAAK,EAAE;oBACT,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;iBACvC;gBACD,OAAM;YACR,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,KAAK,EAAE;oBACT,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;iBACxC;gBACD,OAAM;aACP;YACD;gBACE,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;gBACtC,OAAM;SACT;IACH,CAAC;CACJ,CAAA;AAQD;;GAEG;AACH,MAAqB,QAAQ;IAQ3B,YAAY,EACV,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,QAAQ,EACR,OAAO,GAAG,KAAK,EACf,KAAK,GAAG,KAAK,EACb,YAAY,GAAG,gBAAQ,CAAC,YAAY,EACpC,MAAM,EACN,KAAK,GACM;QAnBb;;;;;WAAsB;QACtB;;;;;WAA+B;QAC/B;;WAEG;QACH;;;;;WAA+C;QAe7C,IAAI,KAAK,IAAI,QAAQ,IAAI,QAAQ,EAAE;YACjC,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAA;SACF;QAED,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;SACnE;QAED,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;SAC7C;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS;YACT,QAAQ;YACR,QAAQ;YACR,iBAAiB;YACjB,QAAQ;YACR,OAAO;YACP,KAAK;YACL,YAAY,EAAE,EAAE,GAAG,gBAAQ,CAAC,YAAY,EAAE,GAAG,YAAY,EAAE;YAC3D,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,iBAAiB,CAAC;YACrE,KAAK,EAAE,KAAK,IAAI,iBAAiB;SAClC,CAAA;QAED,IAAI,CAAC,QAAQ,GAAG,eAAK,CAAC,MAAM,EAAE,CAAA;QAE9B,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAA;YACzB,IAAI,CAAC,mBAAmB,EAAE,CAAA;SAC3B;QAED,IAAI,CAAC,OAAO,GAAG,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IACnF,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;IAC1B,CAAC;IAED,IAAI,KAAK,CAAC,KAAK;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAA;IAC3B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EACpB,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,SAAS,GAMV;QACC,MAAM,MAAM,GAAG,MAAM,eAAK,CAAC,IAAI,CAAC,WAAW,SAAS,IAAI,gBAAQ,CAAC,UAAU,kBAAkB,EAAE;YAC7F,QAAQ;YACR,QAAQ;YACR,iBAAiB;SAClB,CAAC,CAAA;QAEF,OAAO,MAAM,CAAC,IAAI,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,WAAW;QACf,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;YAC9E,OAAO,IAAI,CAAA;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,KAAK,CAAA;SACb;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,GAAG,CAAC,EAChB,IAAI,EACJ,MAAM,EACN,MAAM,EACN,IAAI,GACW;;QACf,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;QACxE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACxC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAA;YAC5F,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAA;YACtC,IAAI,CAAC,mBAAmB,EAAE,CAAA;SAC3B;QAED,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC;gBACjC,GAAG,EAAE,IAAI;gBACT,MAAM;gBACN,MAAM;gBACN,IAAI;aACL,CAAC,CAAA;YAEF,OAAO,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAA;SACpB;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,CAAC,YAAY,EAAE,EAAE;gBACxB,OAAO;oBACL,MAAM,EAAE,MAAA,KAAK,CAAC,QAAQ,0CAAE,MAAM;oBAC9B,IAAI,EAAE,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI;oBAC1B,OAAO,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO;iBACxB,CAAA;aACF;YAED,yCAAyC;YACzC,MAAM,KAAK,CAAA;SACZ;IACH,CAAC;IAEO,mBAAmB;QACzB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;QACpD,IAAI,CAAC,QAAQ,GAAG,eAAK,CAAC,MAAM,CAAC;YAC3B,OAAO;YACP,OAAO,EAAE,WAAW,SAAS,IAAI,gBAAQ,CAAC,UAAU,EAAE;YACtD,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,eAAe,EAAE,UAAU;gBAC3B,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;gBAC5C,QAAQ;aACT;SACF,CAAC,CAAA;IACJ,CAAC;CACF;AAnJD,2BAmJC"}
+{"version":3,"file":"Automate.js","sourceRoot":"","sources":["../src/Automate.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAwD;AAIxD,uCAA6F;AAI7F,MAAM,iBAAiB,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;AAE5C,QAAA,QAAQ,GAIjB;IACF,UAAU,EAAE,KAAK;IACjB,YAAY,EAAE;QACZ,OAAO,EAAE,CAAC;QACV,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,KAAK;QACjB,SAAS,EAAE,IAAI;KAChB;IACD,MAAM,EACJ,CAAC,KAAK,GAAG,KAAK,EAAE,EAAE,CAClB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACpB,QAAQ,KAAK,EAAE;YACb,KAAK,OAAO;gBACV,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;gBACxC,OAAM;YACR,KAAK,MAAM;gBACT,IAAI,KAAK,EAAE;oBACT,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;iBACvC;gBACD,OAAM;YACR,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,KAAK,EAAE;oBACT,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;iBACxC;gBACD,OAAM;aACP;YACD;gBACE,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;gBACtC,OAAM;SACT;IACH,CAAC;CACJ,CAAA;AAQD;;GAEG;AACH,MAAqB,QAAQ;IAyB3B,YAAY,EACV,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,QAAQ,EACR,OAAO,GAAG,KAAK,EACf,KAAK,GAAG,KAAK,EACb,YAAY,GAAG,gBAAQ,CAAC,YAAY,EACpC,MAAM,EACN,KAAK,GACM;QApCb;;;;;WAAsB;QACtB;;;;;WAA+B;QAC/B;;WAEG;QACH;;;;;WAA+C;QAE/C;;;;;;;;;;WAUG;QACH;;;;;WAIuB;QAerB,IAAI,KAAK,IAAI,QAAQ,IAAI,QAAQ,EAAE;YACjC,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAA;SACF;QAED,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;SACnE;QAED,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;SAC7C;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS;YACT,QAAQ;YACR,QAAQ;YACR,iBAAiB;YACjB,QAAQ;YACR,OAAO;YACP,KAAK;YACL,YAAY,EAAE,EAAE,GAAG,gBAAQ,CAAC,YAAY,EAAE,GAAG,YAAY,EAAE;YAC3D,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,iBAAiB,CAAC;YACrE,KAAK,EAAE,KAAK,IAAI,iBAAiB;SAClC,CAAA;QAED,IAAI,CAAC,QAAQ,GAAG,eAAK,CAAC,MAAM,EAAE,CAAA;QAE9B,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAA;YACzB,IAAI,CAAC,mBAAmB,EAAE,CAAA;SAC3B;QAED,IAAI,CAAC,OAAO,GAAG,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QACjF,IAAI,CAAC,QAAQ,GAAG,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IACjD,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;IAC1B,CAAC;IAED,IAAI,KAAK,CAAC,KAAK;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAA;IAC3B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EACpB,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,SAAS,GAMV;QACC,MAAM,MAAM,GAAG,MAAM,eAAK,CAAC,IAAI,CAAC,WAAW,SAAS,IAAI,gBAAQ,CAAC,UAAU,kBAAkB,EAAE;YAC7F,QAAQ;YACR,QAAQ;YACR,iBAAiB;SAClB,CAAC,CAAA;QAEF,OAAO,MAAM,CAAC,IAAI,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,WAAW;QACf,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;YAC9E,OAAO,IAAI,CAAA;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,KAAK,CAAA;SACb;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,GAAG,CAAC,EAChB,IAAI,EACJ,MAAM,EACN,MAAM,EACN,IAAI,GACW;;QACf,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;QACxE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACxC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAA;YAC5F,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAA;YACtC,IAAI,CAAC,mBAAmB,EAAE,CAAA;SAC3B;QAED,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC;gBACjC,GAAG,EAAE,IAAI;gBACT,MAAM;gBACN,MAAM;gBACN,IAAI;aACL,CAAC,CAAA;YAEF,OAAO,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAA;SACpB;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,CAAC,YAAY,EAAE;gBACtB,MAAM;oBACJ,MAAM,EAAE,MAAA,KAAK,CAAC,QAAQ,0CAAE,MAAM;oBAC9B,IAAI,EAAE,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI;oBAC1B,OAAO,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO;iBACxB,CAAA;aACF;YAED,yCAAyC;YACzC,MAAM,KAAK,CAAA;SACZ;IACH,CAAC;IAEO,mBAAmB;QACzB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;QACpD,IAAI,CAAC,QAAQ,GAAG,eAAK,CAAC,MAAM,CAAC;YAC3B,OAAO;YACP,OAAO,EAAE,WAAW,SAAS,IAAI,gBAAQ,CAAC,UAAU,EAAE;YACtD,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,eAAe,EAAE,UAAU;gBAC3B,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;gBAC5C,QAAQ;aACT;SACF,CAAC,CAAA;IACJ,CAAC;CACF;AArKD,2BAqKC"}

package/dist/BaseAPI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseAPI.d.ts","sourceRoot":"","sources":["../src/BaseAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC,OAAO,MAAM,EAAE,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,QAAQ,EAAE,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAGrD;;;GAGG;AACH,eAAO,MAAM,WAAW;YAMZ,YAAY,GAAG,cAAc;gBACzB,cAAc,KAAK,QAAQ,OAAO,CAAC;aACtC,aAAa,eAAe,GAAG,aAAa,CAAC;aAC5C,cAAc,KAAK,QAAQ,OAAO,CAgE7C,CAAA;AAEH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,YAAY,CAAC,OAAO,QAAQ,GAAG,OAAO,MAAM,CAAC,CAAA;CACvD;AAGD,oBAAY,mBAAmB,GAAG,QAAQ,CAAA;AAE1C,oBAAY,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,gBACT,gBAAgB,iBAEjB,mBAAmB,iBAChB,iBAAiB,iBAChB,OAAO,MAAM,EAAE,OAAO,CAAC,EAAE,KACvC,QAAQ,OAAO,EAAE,CA6BnB,CAAA"}
+{"version":3,"file":"BaseAPI.d.ts","sourceRoot":"","sources":["../src/BaseAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC,OAAO,MAAM,EAAE,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,QAAQ,EAAE,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAGrD;;;GAGG;AACH,eAAO,MAAM,WAAW;YAMZ,YAAY,GAAG,cAAc;gBACzB,cAAc,KAAK,QAAQ,OAAO,CAAC;aACtC,aAAa,eAAe,GAAG,aAAa,CAAC;aAC5C,cAAc,KAAK,QAAQ,OAAO,CAgE7C,CAAA;AAEH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,YAAY,CAAC,OAAO,QAAQ,GAAG,OAAO,MAAM,CAAC,CAAA;CACvD;AAGD,oBAAY,mBAAmB,GAAG,QAAQ,CAAA;AAE1C,oBAAY,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,gBACT,gBAAgB,iBAEjB,mBAAmB,iBAChB,iBAAiB,iBAChB,OAAO,MAAM,EAAE,OAAO,CAAC,EAAE,KACvC,QAAQ,OAAO,EAAE,CAiCnB,CAAA"}

package/dist/BaseAPI.js

@@ -55,22 +55,26 @@ exports.makeRequest = makeRequest;
  * @internal
  */
 const makePaginate = ({ thisObj }) => (apiMethod, paginateArgs = {}, ...methodArgs) => {
-    const { startPage = 0, pageSize = 1000 } = paginateArgs;
+    const { startPage = 1, pageSize = 1000 } = paginateArgs;
     return new Promise(async (resolve, reject) => {
         let results = [];
         let page = startPage;
         if (startPage === undefined || startPage < 1) {
-            page = 0;
+            page = 1;
         }
         while (true) {
             try {
-                const result = await getPage(apiMethod, methodArgs, thisObj, page++, pageSize);
+                const pageResults = await getPage(apiMethod, methodArgs, thisObj, page++, pageSize);
                 // complete page returned, loop again
-                if (Array.isArray(result) && result.length > 0) {
-                    results = results.concat(result);
+                if (Array.isArray(pageResults) && pageResults.length > 0) {
+                    results = [...results, ...pageResults];
+                    if (pageResults.length !== pageSize) {
+                        // incomplete page, there are no more pages
+                        break;
+                    }
                 }
                 else {
-                    // incomplete page, this is the last page of results, exit loop and return
+                    // no results returned, this is the last page, previous page was full
                     break;
                 }
             }

package/dist/BaseAPI.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseAPI.js","sourceRoot":"","sources":["../src/BaseAPI.ts"],"names":[],"mappings":";;;;;;AACA,kEAAwC;AAKxC;;;GAGG;AACI,MAAM,WAAW,GACtB,CAAC,EACC,MAAM,EACN,GAAG,EACH,OAAO,GAKR,EAAgD,EAAE,CACnD,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,EAAE,IAAI,EAAkB,EAAoB,EAAE;IAC3E,MAAM,UAAU,GAAG,CAAC,YAAY,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAA;IACjE,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAElC,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;KACzC;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAC1B,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAE9C,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;aAC5C,IAAI,CAAC,CAAC,MAAW,EAAE,EAAE;YACpB,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACjF,CAAA;YACD,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAA0C,EAAE,EAAE;YACpD,MAAM,CACJ,OAAO,EACP,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAChF,KAAK,CACN,CAAA;YACD,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;KACL;SAAM;QACL,OAAO,IAAA,uBAAY,EAAC,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAClD,OAAO,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC9D,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,sBACzC,KAAK,CAAC,IACR,WAAW,MAAM,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACtD,CAAA;gBACD,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;gBACtB,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;oBACnC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;iBACpB;gBACD,MAAM,KAAK,CAAA;YACb,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC;aACC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACjF,CAAA;YAED,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,CACJ,OAAO,EACP,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,sBACzC,KAAK,CAAC,IACR,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EACpC,KAAK,CACN,CAAA;YACD,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;KACL;AACH,CAAC,CAAA;AAzEU,QAAA,WAAW,eAyErB;AAcH;;;GAGG;AACI,MAAM,YAAY,GACvB,CAAC,EAAE,OAAO,EAAoB,EAAE,EAAE,CAClC,CACE,SAA8B,EAC9B,eAAkC,EAAE,EACpC,GAAG,UAAqC,EACpB,EAAE;IACtB,MAAM,EAAE,SAAS,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAEvD,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,OAAO,GAAc,EAAE,CAAA;QAE3B,IAAI,IAAI,GAAG,SAAS,CAAA;QAEpB,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;YAC5C,IAAI,GAAG,CAAC,CAAA;SACT;QAED,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAA;gBAC9E,qCAAqC;gBACrC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC9C,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;iBACjC;qBAAM;oBACL,0EAA0E;oBAC1E,MAAK;iBACN;aACF;YAAC,OAAO,KAAc,EAAE;gBACvB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;aACrB;SACF;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAnCU,QAAA,YAAY,gBAmCtB;AAEH;;GAEG;AACH,SAAS,OAAO,CACd,SAA8B,EAC9B,UAAqC,EACrC,OAAsD,EACtD,IAAI,GAAG,CAAC,EACR,QAAQ,GAAG,IAAI;IAEf,kEAAkE;IAClE,kEAAkE;IAClE,oEAAoE;IACpE,4BAA4B;IAC5B,IAAI,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE;QACxC,MAAM,IAAI,KAAK,CACb,+EAA+E,SAAS,CAAC,IAAI,EAAE,CAChG,CAAA;KACF;IAED,qDAAqD;IACrD,2CAA2C;IAC3C,eAAe;IACf,MAAM,YAAY,GAAqB,UAAU,CAAC,GAAG,EAAE,CAAA;IACvD,YAAY,CAAC,IAAI,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAEhC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IAE7B,OAAO,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;AAC7C,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,KAAc;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;QAC/C,OAAO,IAAI,CAAA;KACZ;SAAM;QACL,OAAO,KAAK,CAAA;KACb;AACH,CAAC"}
+{"version":3,"file":"BaseAPI.js","sourceRoot":"","sources":["../src/BaseAPI.ts"],"names":[],"mappings":";;;;;;AACA,kEAAwC;AAKxC;;;GAGG;AACI,MAAM,WAAW,GACtB,CAAC,EACC,MAAM,EACN,GAAG,EACH,OAAO,GAKR,EAAgD,EAAE,CACnD,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,EAAE,IAAI,EAAkB,EAAoB,EAAE;IAC3E,MAAM,UAAU,GAAG,CAAC,YAAY,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAA;IACjE,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAElC,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;KACzC;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAC1B,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAE9C,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;aAC5C,IAAI,CAAC,CAAC,MAAW,EAAE,EAAE;YACpB,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACjF,CAAA;YACD,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAA0C,EAAE,EAAE;YACpD,MAAM,CACJ,OAAO,EACP,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAChF,KAAK,CACN,CAAA;YACD,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;KACL;SAAM;QACL,OAAO,IAAA,uBAAY,EAAC,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAClD,OAAO,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC9D,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,sBACzC,KAAK,CAAC,IACR,WAAW,MAAM,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACtD,CAAA;gBACD,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;gBACtB,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;oBACnC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;iBACpB;gBACD,MAAM,KAAK,CAAA;YACb,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC;aACC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACjF,CAAA;YAED,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,CACJ,OAAO,EACP,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,sBACzC,KAAK,CAAC,IACR,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EACpC,KAAK,CACN,CAAA;YACD,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;KACL;AACH,CAAC,CAAA;AAzEU,QAAA,WAAW,eAyErB;AAcH;;;GAGG;AACI,MAAM,YAAY,GACvB,CAAC,EAAE,OAAO,EAAoB,EAAE,EAAE,CAClC,CACE,SAA8B,EAC9B,eAAkC,EAAE,EACpC,GAAG,UAAqC,EACpB,EAAE;IACtB,MAAM,EAAE,SAAS,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAEvD,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,OAAO,GAAc,EAAE,CAAA;QAE3B,IAAI,IAAI,GAAG,SAAS,CAAA;QAEpB,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;YAC5C,IAAI,GAAG,CAAC,CAAA;SACT;QAED,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAA;gBACnF,qCAAqC;gBACrC,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;oBACxD,OAAO,GAAG,CAAC,GAAG,OAAO,EAAE,GAAG,WAAW,CAAC,CAAA;oBACtC,IAAI,WAAW,CAAC,MAAM,KAAK,QAAQ,EAAE;wBACnC,2CAA2C;wBAC3C,MAAK;qBACN;iBACF;qBAAM;oBACL,qEAAqE;oBACrE,MAAK;iBACN;aACF;YAAC,OAAO,KAAc,EAAE;gBACvB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;aACrB;SACF;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAvCU,QAAA,YAAY,gBAuCtB;AAEH;;GAEG;AACH,SAAS,OAAO,CACd,SAA8B,EAC9B,UAAqC,EACrC,OAAsD,EACtD,IAAI,GAAG,CAAC,EACR,QAAQ,GAAG,IAAI;IAEf,kEAAkE;IAClE,kEAAkE;IAClE,oEAAoE;IACpE,4BAA4B;IAC5B,IAAI,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE;QACxC,MAAM,IAAI,KAAK,CACb,+EAA+E,SAAS,CAAC,IAAI,EAAE,CAChG,CAAA;KACF;IAED,qDAAqD;IACrD,2CAA2C;IAC3C,eAAe;IACf,MAAM,YAAY,GAAqB,UAAU,CAAC,GAAG,EAAE,CAAA;IACvD,YAAY,CAAC,IAAI,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAEhC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IAE7B,OAAO,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;AAC7C,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,KAAc;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;QAC/C,OAAO,IAAI,CAAA;KACZ;SAAM;QACL,OAAO,KAAK,CAAA;KACb;AACH,CAAC"}

package/dist/Manage.d.ts

@@ -28,6 +28,14 @@ export default class Manage {
     request: (args: RequestOptions) => Promise<any>;
     /**
      * @public
+     * Pass the function to be paginated first, then arguments to paginate itself,
+     * then any additional arguments to the function in order
+     *
+     * @example
+     * ```javascript
+     *  cwm.paginate(cwm.FinanceAPI.getFinanceAgreements, {startPage: 1, pageSize: 500}, {conditions: 'inactiveFlag = false'})
+     *
+     * ```
      */
     paginate: (apiMethod: PaginationApiMethod, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>;
     constructor({ companyId, publicKey, privateKey, companyUrl, clientId, entryPoint, timeout, apiVersion, retry, retryOptions, logger, debug, }: CWMOptions);

package/dist/Manage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Manage.d.ts","sourceRoot":"","sources":["../src/Manage.ts"],"names":[],"mappings":"AACA,OAAO,EAA6B,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAE7F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAA+B,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAI7F,eAAO,MAAM,QAAQ,EAAE;IACrB,YAAY,EAAE,YAAY,CAAA;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,QAAQ,CAAA;CAgCrC,CAAA;AAED,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,YAAY,EAAE,YAAY,CAAA;IAC1B,MAAM,EAAE,QAAQ,CAAA;IAChB,KAAK,EAAE,OAAO,CAAA;CACf;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,MAAM,EAAE,YAAY,CAAA;IACpB,OAAO,CAAC,QAAQ,CAAe;IAC/B;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAC/C;;OAEG;IACH,QAAQ,EAAE,CACR,SAAS,EAAE,mBAAmB,EAC9B,YAAY,EAAE,iBAAiB,EAC/B,GAAG,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KACrC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;gBAEX,EACV,SAAS,EACT,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,UAA2B,EAC3B,OAAe,EACf,UAAqB,EACrB,KAAa,EACb,YAAoC,EACpC,MAAM,EACN,KAAa,GACd,EAAE,UAAU;IAyCb;;OAEG;YACW,GAAG;CA4BlB"}
+{"version":3,"file":"Manage.d.ts","sourceRoot":"","sources":["../src/Manage.ts"],"names":[],"mappings":"AACA,OAAO,EAA6B,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAE7F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAA+B,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAI7F,eAAO,MAAM,QAAQ,EAAE;IACrB,YAAY,EAAE,YAAY,CAAA;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,QAAQ,CAAA;CAgCrC,CAAA;AAED,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,YAAY,EAAE,YAAY,CAAA;IAC1B,MAAM,EAAE,QAAQ,CAAA;IAChB,KAAK,EAAE,OAAO,CAAA;CACf;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,MAAM,EAAE,YAAY,CAAA;IACpB,OAAO,CAAC,QAAQ,CAAe;IAE/B;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAE/C;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,CACR,SAAS,EAAE,mBAAmB,EAC9B,YAAY,EAAE,iBAAiB,EAC/B,GAAG,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KACrC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;gBAEX,EACV,SAAS,EACT,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,UAA2B,EAC3B,OAAe,EACf,UAAqB,EACrB,KAAa,EACb,YAAoC,EACpC,MAAM,EACN,KAAa,GACd,EAAE,UAAU;IAyCb;;OAEG;YACW,GAAG;CA4BlB"}

package/dist/Manage.js

@@ -65,6 +65,14 @@ class Manage {
         });
         /**
          * @public
+         * Pass the function to be paginated first, then arguments to paginate itself,
+         * then any additional arguments to the function in order
+         *
+         * @example
+         * ```javascript
+         *  cwm.paginate(cwm.FinanceAPI.getFinanceAgreements, {startPage: 1, pageSize: 500}, {conditions: 'inactiveFlag = false'})
+         *
+         * ```
          */
         Object.defineProperty(this, "paginate", {
             enumerable: true,
@@ -121,8 +129,8 @@ class Manage {
             return result === null || result === void 0 ? void 0 : result.data;
         }
         catch (error) {
-            if (error.isAxiosError()) {
-                return {
+            if (error.isAxiosError) {
+                throw {
                     status: (_a = error.response) === null || _a === void 0 ? void 0 : _a.status,
                     data: (_b = error.response) === null || _b === void 0 ? void 0 : _b.data,
                     message: error === null || error === void 0 ? void 0 : error.message,

package/dist/Manage.js.map

@@ -1 +1 @@
-{"version":3,"file":"Manage.js","sourceRoot":"","sources":["../src/Manage.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAuE;AACvE,uCAA6F;AAK7F,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAA;AAExC,QAAA,QAAQ,GAIjB;IACF,OAAO,EAAE,WAAW;IACpB,YAAY,EAAE;QACZ,OAAO,EAAE,CAAC;QACV,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,KAAK;QACjB,SAAS,EAAE,IAAI;KAChB;IACD,MAAM,EACJ,CAAC,KAAK,GAAG,KAAK,EAAE,EAAE,CAClB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACpB,QAAQ,KAAK,EAAE;YACb,KAAK,OAAO;gBACV,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;gBACxC,OAAM;YACR,KAAK,MAAM;gBACT,IAAI,KAAK,EAAE;oBACT,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;iBACvC;gBACD,OAAM;YACR,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,KAAK,EAAE;oBACT,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;iBACxC;gBACD,OAAM;aACP;YACD;gBACE,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;gBACtC,OAAM;SACT;IACH,CAAC;CACJ,CAAA;AAaD;;GAEG;AACH,MAAqB,MAAM;IAgBzB,YAAY,EACV,SAAS,EACT,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,UAAU,GAAG,cAAc,EAC3B,OAAO,GAAG,KAAK,EACf,UAAU,GAAG,QAAQ,EACrB,KAAK,GAAG,KAAK,EACb,YAAY,GAAG,gBAAQ,CAAC,YAAY,EACpC,MAAM,EACN,KAAK,GAAG,KAAK,GACF;QA5Bb;;;;;WAAoB;QACpB;;;;;WAA+B;QAC/B;;WAEG;QACH;;;;;WAA+C;QAC/C;;WAEG;QACH;;;;;WAIuB;QAgBrB,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE;YACvE,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAA;SAC5F;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS;YACT,SAAS;YACT,UAAU;YACV,UAAU;YACV,QAAQ;YACR,UAAU;YACV,UAAU;YACV,KAAK;YACL,OAAO;YACP,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,eAAe,CAAC;YACnE,KAAK,EAAE,KAAK,IAAI,eAAe;YAC/B,YAAY,EAAE;gBACZ,GAAG,gBAAQ,CAAC,YAAY;gBACxB,GAAG,YAAY;aAChB;YACD,aAAa,EAAE,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC,CAAC,QAAQ,CACrF,QAAQ,CACT,EAAE;SACJ,CAAA;QAED,IAAI,CAAC,QAAQ,GAAG,eAAK,CAAC,MAAM,CAAC;YAC3B,OAAO;YACP,OAAO,EAAE,WAAW,UAAU,IAAI,UAAU,GAAG,gBAAQ,CAAC,OAAO,EAAE;YACjE,OAAO,EAAE;gBACP,MAAM,EAAE,iDAAiD,UAAU,oBAAoB;gBACvF,eAAe,EAAE,UAAU;gBAC3B,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;gBACxC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;aAC/B;SACF,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,GAAG,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QACjF,IAAI,CAAC,QAAQ,GAAG,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IACjD,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,GAAG,CAAC,EAChB,IAAI,EACJ,MAAM,EACN,MAAM,EACN,IAAI,GACW;;QACf,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC;gBACjC,GAAG,EAAE,IAAI;gBACT,MAAM;gBACN,MAAM;gBACN,IAAI;aACL,CAAC,CAAA;YAEF,OAAO,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAA;SACpB;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,CAAC,YAAY,EAAE,EAAE;gBACxB,OAAO;oBACL,MAAM,EAAE,MAAA,KAAK,CAAC,QAAQ,0CAAE,MAAM;oBAC9B,IAAI,EAAE,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI;oBAC1B,OAAO,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO;iBACxB,CAAA;aACF;YAED,yCAAyC;YACzC,MAAM,KAAK,CAAA;SACZ;IACH,CAAC;CACF;AArGD,yBAqGC"}
+{"version":3,"file":"Manage.js","sourceRoot":"","sources":["../src/Manage.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAuE;AACvE,uCAA6F;AAK7F,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAA;AAExC,QAAA,QAAQ,GAIjB;IACF,OAAO,EAAE,WAAW;IACpB,YAAY,EAAE;QACZ,OAAO,EAAE,CAAC;QACV,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,KAAK;QACjB,SAAS,EAAE,IAAI;KAChB;IACD,MAAM,EACJ,CAAC,KAAK,GAAG,KAAK,EAAE,EAAE,CAClB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACpB,QAAQ,KAAK,EAAE;YACb,KAAK,OAAO;gBACV,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;gBACxC,OAAM;YACR,KAAK,MAAM;gBACT,IAAI,KAAK,EAAE;oBACT,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;iBACvC;gBACD,OAAM;YACR,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,KAAK,EAAE;oBACT,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;iBACxC;gBACD,OAAM;aACP;YACD;gBACE,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;gBACtC,OAAM;SACT;IACH,CAAC;CACJ,CAAA;AAaD;;GAEG;AACH,MAAqB,MAAM;IA0BzB,YAAY,EACV,SAAS,EACT,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,UAAU,GAAG,cAAc,EAC3B,OAAO,GAAG,KAAK,EACf,UAAU,GAAG,QAAQ,EACrB,KAAK,GAAG,KAAK,EACb,YAAY,GAAG,gBAAQ,CAAC,YAAY,EACpC,MAAM,EACN,KAAK,GAAG,KAAK,GACF;QAtCb;;;;;WAAoB;QACpB;;;;;WAA+B;QAE/B;;WAEG;QACH;;;;;WAA+C;QAE/C;;;;;;;;;;WAUG;QACH;;;;;WAIuB;QAgBrB,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE;YACvE,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAA;SAC5F;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS;YACT,SAAS;YACT,UAAU;YACV,UAAU;YACV,QAAQ;YACR,UAAU;YACV,UAAU;YACV,KAAK;YACL,OAAO;YACP,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,eAAe,CAAC;YACnE,KAAK,EAAE,KAAK,IAAI,eAAe;YAC/B,YAAY,EAAE;gBACZ,GAAG,gBAAQ,CAAC,YAAY;gBACxB,GAAG,YAAY;aAChB;YACD,aAAa,EAAE,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC,CAAC,QAAQ,CACrF,QAAQ,CACT,EAAE;SACJ,CAAA;QAED,IAAI,CAAC,QAAQ,GAAG,eAAK,CAAC,MAAM,CAAC;YAC3B,OAAO;YACP,OAAO,EAAE,WAAW,UAAU,IAAI,UAAU,GAAG,gBAAQ,CAAC,OAAO,EAAE;YACjE,OAAO,EAAE;gBACP,MAAM,EAAE,iDAAiD,UAAU,oBAAoB;gBACvF,eAAe,EAAE,UAAU;gBAC3B,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;gBACxC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;aAC/B;SACF,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,GAAG,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QACjF,IAAI,CAAC,QAAQ,GAAG,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IACjD,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,GAAG,CAAC,EAChB,IAAI,EACJ,MAAM,EACN,MAAM,EACN,IAAI,GACW;;QACf,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC;gBACjC,GAAG,EAAE,IAAI;gBACT,MAAM;gBACN,MAAM;gBACN,IAAI;aACL,CAAC,CAAA;YAEF,OAAO,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAA;SACpB;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,CAAC,YAAY,EAAE;gBACtB,MAAM;oBACJ,MAAM,EAAE,MAAA,KAAK,CAAC,QAAQ,0CAAE,MAAM;oBAC9B,IAAI,EAAE,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI;oBAC1B,OAAO,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO;iBACxB,CAAA;aACF;YAED,yCAAyC;YACzC,MAAM,KAAK,CAAA;SACZ;IACH,CAAC;CACF;AA/GD,yBA+GC"}

package/dist/utils/ReportInterpolate.d.ts

@@ -0,0 +1,7 @@
+import type { ReportDataResponse } from '../Manage/SystemAPI';
+/**
+ * Transform a report column/value response object into an array
+ * @param {ReportDataResponse} args
+ */
+export declare function reportInterpolate(...args: ReportDataResponse[]): Record<string, unknown>[];
+//# sourceMappingURL=ReportInterpolate.d.ts.map

package/dist/utils/ReportInterpolate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReportInterpolate.d.ts","sourceRoot":"","sources":["../../src/utils/ReportInterpolate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE7D;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,IAAI,EAAE,kBAAkB,EAAE,6BAuB9D"}

package/dist/utils/ReportInterpolate.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reportInterpolate = void 0;
+/**
+ * Transform a report column/value response object into an array
+ * @param {ReportDataResponse} args
+ */
+function reportInterpolate(...args) {
+    const data = args.length > 0 && args[0] !== undefined ? args[0] : { column_definitions: [], row_values: [] };
+    /* report data comes in like this:
+     *  {
+     *    column_definitions: [{ ColumnName: { DataType: 'number', IsNullable: true/false } } ... { ... } ],
+     *    row_values: [ [1, 2, 'some string', '1900-01-01etc', null, null, false, ... ], [ ... ] ]
+     *  }
+     */
+    const column_definitions = data.column_definitions || [];
+    const row_values = data.row_values || [];
+    return row_values.map((rowArray) => {
+        const rowObj = {};
+        rowArray.forEach((value, idx) => {
+            const key = Object.keys(column_definitions[idx])[0];
+            rowObj[key] = value;
+        });
+        return rowObj;
+    });
+    // return an array like: [ { key: value, key2: value2 ... }, ... ]
+}
+exports.reportInterpolate = reportInterpolate;
+//# sourceMappingURL=ReportInterpolate.js.map

package/dist/utils/ReportInterpolate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReportInterpolate.js","sourceRoot":"","sources":["../../src/utils/ReportInterpolate.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,GAAG,IAA0B;IAC7D,MAAM,IAAI,GACR,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;IAEjG;;;;;OAKG;IAEH,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAA;IACxD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,CAAA;IAExC,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,QAAwB,EAAE,EAAE;QACjD,MAAM,MAAM,GAA4B,EAAE,CAAA;QAC1C,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACnD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QACrB,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC,CAAC,CAAA;IACF,kEAAkE;AACpE,CAAC;AAvBD,8CAuBC"}

package/dist/utils/index.d.ts

@@ -2,6 +2,7 @@ import type * as SeriesTypes from './Series';
 import type * as CallbackTypes from './Callback';
 import Series from './Series';
 import Callback from './Callback';
+import { reportInterpolate } from './ReportInterpolate';
 export type { SeriesTypes, CallbackTypes };
-export { Series, Callback };
+export { Series, Callback, reportInterpolate };
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,KAAK,aAAa,MAAM,YAAY,CAAA;AAChD,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,QAAQ,MAAM,YAAY,CAAA;AAEjC,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,KAAK,aAAa,MAAM,YAAY,CAAA;AAChD,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAEvD,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAA"}

package/dist/utils/index.js

@@ -3,9 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Callback = exports.Series = void 0;
+exports.reportInterpolate = exports.Callback = exports.Series = void 0;
 const Series_1 = __importDefault(require("./Series"));
 exports.Series = Series_1.default;
 const Callback_1 = __importDefault(require("./Callback"));
 exports.Callback = Callback_1.default;
+const ReportInterpolate_1 = require("./ReportInterpolate");
+Object.defineProperty(exports, "reportInterpolate", { enumerable: true, get: function () { return ReportInterpolate_1.reportInterpolate; } });
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;AAEA,sDAA6B;AAIpB,iBAJF,gBAAM,CAIE;AAHf,0DAAiC;AAGhB,mBAHV,kBAAQ,CAGU"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;AAEA,sDAA6B;AAKpB,iBALF,gBAAM,CAKE;AAJf,0DAAiC;AAIhB,mBAJV,kBAAQ,CAIU;AAHzB,2DAAuD;AAG5B,kGAHlB,qCAAiB,OAGkB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "connectwise-rest",
-  "version": "1.0.1",
+  "version": "1.2.1",
   "description": "A nodejs module for interacting with the ConnectWise Manage and Automate REST APIs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,7 @@
     "clean:dist": "npx rimraf dist/",
     "clean:src": "npx rimraf src/Manage/ & npx rimraf src/Automate/",
     "clean": "npm run clean:dist & npm run clean:generator & npm run clean:src",
-    "test": "npx nyc mocha -r ts-node/register",
+    "test": "npx nyc mocha",
     "pregenerate": "npm run clean",
     "generate:automate": "node generator/automate-generator.js",
     "generate:manage": "node generator/manage-generator.js",
@@ -19,7 +19,7 @@
     "postbuild": "npm run lint",
     "lint": "npx eslint -c .eslintrc --fix",
     "coveralls": "npx nyc report --reporter=text-lcov > ./.nyc_output/lcov.info",
-    "pretypedocs": "npm run clean:docs",
+    "predocs": "npm run clean:docs",
     "docs": "npx typedoc src/index.ts",
     "preapidocumenter": "npx api-extractor run --local --verbose",
     "apidocumenter": "npx api-documenter markdown --input-folder temp --output-folder docs",
@@ -69,7 +69,7 @@
     "mocha": "^9.2.2",
     "mocha-lcov-reporter": "^1.3.0",
     "nyc": "^15.1.0",
-    "openapi-typescript": "^5.2.0",
+    "openapi-typescript": "^5.4.1",
     "prettier": "^2.6.0",
     "rimraf": "^3.0.2",
     "ts-node": "^10.7.0",

package/src/Automate.ts

@@ -2,7 +2,7 @@ import axios, { AxiosInstance, AxiosError } from 'axios'
 import { CWLogger, DataResponse, ErrorResponse, RequestOptions, RetryOptions } from './types'
 import { CWAOptions } from './AutomateAPI'
 import { components } from './AutomateTypes'
-import { makeRequest } from './BaseAPI'
+import { makePaginate, makeRequest, PaginationApiMethod, PaginationOptions } from './BaseAPI'
 type schemas = components['schemas']
 type TokenResult = schemas['Automate.Api.Domain.Contracts.Security.TokenResult']
 
@@ -62,6 +62,23 @@ export default class Automate {
    */
   request: (args: RequestOptions) => Promise<any>
 
+  /**
+   * @public
+   * Pass the function to be paginated first, then arguments to paginate itself,
+   * then any additional arguments to the function in order
+   *
+   * @example
+   * ```javascript
+   *  cwa.paginate(cwa.ComputersAPI.getComputerList, {startPage: 1, pageSize: 1000}, {conditions: 'inactiveFlag = false'})
+   *
+   * ```
+   */
+  paginate: (
+    apiMethod: PaginationApiMethod,
+    paginateArgs: PaginationOptions,
+    ...methodArgs: Record<string, unknown>[]
+  ) => Promise<unknown[]>
+
   constructor({
     serverUrl,
     username,
@@ -110,6 +127,7 @@ export default class Automate {
     }
 
     this.request = makeRequest({ config: this.config, api: this.api, thisObj: this })
+    this.paginate = makePaginate({ thisObj: this })
   }
 
   get token() {
@@ -175,8 +193,8 @@ export default class Automate {
 
       return result?.data
     } catch (error: any) {
-      if (error.isAxiosError()) {
-        return {
+      if (error.isAxiosError) {
+        throw {
           status: error.response?.status,
           data: error.response?.data,
           message: error?.message,

package/src/BaseAPI.ts

@@ -106,7 +106,7 @@ export const makePaginate =
     paginateArgs: PaginationOptions = {},
     ...methodArgs: Record<string, unknown>[]
   ): Promise<unknown[]> => {
-    const { startPage = 0, pageSize = 1000 } = paginateArgs
+    const { startPage = 1, pageSize = 1000 } = paginateArgs
 
     return new Promise(async (resolve, reject) => {
       let results: unknown[] = []
@@ -114,17 +114,21 @@ export const makePaginate =
       let page = startPage
 
       if (startPage === undefined || startPage < 1) {
-        page = 0
+        page = 1
       }
 
       while (true) {
         try {
-          const result = await getPage(apiMethod, methodArgs, thisObj, page++, pageSize)
+          const pageResults = await getPage(apiMethod, methodArgs, thisObj, page++, pageSize)
           // complete page returned, loop again
-          if (Array.isArray(result) && result.length > 0) {
-            results = results.concat(result)
+          if (Array.isArray(pageResults) && pageResults.length > 0) {
+            results = [...results, ...pageResults]
+            if (pageResults.length !== pageSize) {
+              // incomplete page, there are no more pages
+              break
+            }
           } else {
-            // incomplete page, this is the last page of results, exit loop and return
+            // no results returned, this is the last page, previous page was full
             break
           }
         } catch (error: unknown) {

package/src/Manage.ts

@@ -60,12 +60,22 @@ export interface ManageConfig extends CWMOptions {
 export default class Manage {
   config: ManageConfig
   private instance: AxiosInstance
+
   /**
    * @public
    */
   request: (args: RequestOptions) => Promise<any>
+
   /**
    * @public
+   * Pass the function to be paginated first, then arguments to paginate itself,
+   * then any additional arguments to the function in order
+   *
+   * @example
+   * ```javascript
+   *  cwm.paginate(cwm.FinanceAPI.getFinanceAgreements, {startPage: 1, pageSize: 500}, {conditions: 'inactiveFlag = false'})
+   *
+   * ```
    */
   paginate: (
     apiMethod: PaginationApiMethod,
@@ -146,8 +156,8 @@ export default class Manage {
 
       return result?.data
     } catch (error: any) {
-      if (error.isAxiosError()) {
-        return {
+      if (error.isAxiosError) {
+        throw {
           status: error.response?.status,
           data: error.response?.data,
           message: error?.message,

package/src/utils/ReportInterpolate.ts

@@ -0,0 +1,30 @@
+import type { ReportDataResponse } from '../Manage/SystemAPI'
+
+/**
+ * Transform a report column/value response object into an array
+ * @param {ReportDataResponse} args
+ */
+export function reportInterpolate(...args: ReportDataResponse[]) {
+  const data =
+    args.length > 0 && args[0] !== undefined ? args[0] : { column_definitions: [], row_values: [] }
+
+  /* report data comes in like this:
+   *  {
+   *    column_definitions: [{ ColumnName: { DataType: 'number', IsNullable: true/false } } ... { ... } ],
+   *    row_values: [ [1, 2, 'some string', '1900-01-01etc', null, null, false, ... ], [ ... ] ]
+   *  }
+   */
+
+  const column_definitions = data.column_definitions || []
+  const row_values = data.row_values || []
+
+  return row_values.map((rowArray: Array<unknown>) => {
+    const rowObj: Record<string, unknown> = {}
+    rowArray.forEach((value, idx) => {
+      const key = Object.keys(column_definitions[idx])[0]
+      rowObj[key] = value
+    })
+    return rowObj
+  })
+  // return an array like: [ { key: value, key2: value2 ... }, ... ]
+}

package/src/utils/index.ts

@@ -2,6 +2,7 @@ import type * as SeriesTypes from './Series'
 import type * as CallbackTypes from './Callback'
 import Series from './Series'
 import Callback from './Callback'
+import { reportInterpolate } from './ReportInterpolate'
 
 export type { SeriesTypes, CallbackTypes }
-export { Series, Callback }
+export { Series, Callback, reportInterpolate }

package/test/test-utils.js

@@ -0,0 +1,19 @@
+exports.isPromise = function isPromise(input) {
+  return (
+    !!input &&
+    (typeof input === 'object' || typeof input === 'function') &&
+    typeof input.then === 'function'
+  )
+}
+
+exports.isArrayOfPromises = function isArrayOfPromises(input) {
+  if (Array.isArray(input)) {
+    if (Array.length === 0) {
+      return true
+    }
+    if (exports.isPromise(input.pop)) {
+      return true
+    }
+  }
+  return false
+}

package/test/{test.ts → test.js}

@@ -1,38 +1,16 @@
 /**
  * Created by kgrube on 9/11/2018
  */
-import dotenv from 'dotenv'
-import path from 'path'
-import { ManageAPI, AutomateAPI, utils } from '../dist/index'
-// import { ManageAPI, AutomateAPI, utils } from '../src/index'
-import assert from 'assert'
-import { describe, it } from 'mocha'
-import type { components } from '../src/ManageTypes'
-import { isPromise } from './test-utils'
-import { LabTechModelsComputer } from '../src/Automate/ComputersAPI'
-import { CommunicationType } from '../src/Manage/CompanyAPI'
-type Ticket = components['schemas']['Ticket']
+/* eslint-disable @typescript-eslint/no-var-requires */
+const dotenv = require('dotenv')
+const path = require('path')
+const { ManageAPI, AutomateAPI, utils } = require('../dist')
+const assert = require('assert')
+const { describe, it } = require('mocha')
+const { isPromise } = require('./test-utils.js')
 
 dotenv.config({ path: path.join(__dirname, '.env') })
 
-declare global {
-  // eslint-disable-next-line @typescript-eslint/no-namespace
-  namespace NodeJS {
-    interface ProcessEnv {
-      MANAGE_API_COMPANY: string
-      MANAGE_API_URL: string
-      MANAGE_API_PUBLIC_KEY: string
-      MANAGE_API_PRIVATE_KEY: string
-      MANAGE_API_CLIENT_ID: string
-      AUTOMATE_API_CLIENT_ID: string
-      AUTOMATE_API_PASSWORD: string
-      AUTOMATE_API_URL: string
-      AUTOMATE_API_USER: string
-      NODE_ENV: 'development' | 'production'
-    }
-  }
-}
-
 const {
   MANAGE_API_COMPANY,
   MANAGE_API_URL,
@@ -52,6 +30,8 @@ const cwm = new ManageAPI({
   privateKey: MANAGE_API_PRIVATE_KEY,
   clientId: MANAGE_API_CLIENT_ID,
   apiVersion: '2021.2',
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  logger: () => {},
 })
 
 const cwa = new AutomateAPI({
@@ -59,6 +39,8 @@ const cwa = new AutomateAPI({
   serverUrl: AUTOMATE_API_URL,
   username: AUTOMATE_API_USER,
   password: AUTOMATE_API_PASSWORD,
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  logger: () => {},
 })
 
 describe('Automate', () => {
@@ -149,7 +131,7 @@ describe('Automate', () => {
   describe('ComputersAPI', () => {
     it('should return a list of computers', (done) => {
       cwa.ComputersAPI.getComputerList({ pageSize: 1 })
-        .then((results: LabTechModelsComputer[]) => {
+        .then((results) => {
           assert(results.length === 1)
           const computer = results[0]
           assert(computer.Id)
@@ -229,7 +211,7 @@ describe('Manage', () => {
     })
   })
 
-  describe('ServiceDeskAPI', () => {
+  describe('ServiceAPI', () => {
     describe('getServiceTicketsById', () => {
       it('should return a ticket object', (done) => {
         cwm.ServiceAPI.getServiceTicketsById(123456)
@@ -237,7 +219,7 @@ describe('Manage', () => {
             if (!result) {
               done('No result')
             }
-            const { id, summary } = <Ticket>result
+            const { id, summary } = result
             assert(id, summary)
             done()
           })
@@ -260,6 +242,20 @@ describe('Manage', () => {
           .catch((err) => done(err))
       })
     })
+
+    describe('error', () => {
+      it('should return a 404 not found error', (done) => {
+        cwm.ServiceAPI.getServiceBoardsByGrandparentIdItemsByParentIdAssociations(9999, 9999)
+          .then(() => {
+            return done(new Error('Incorrect response'))
+          })
+          .catch((err) => {
+            assert(err)
+            assert(err.status === 404)
+            done()
+          })
+      })
+    })
   })
 
   describe('pagination', () => {
@@ -269,7 +265,7 @@ describe('Manage', () => {
         .then((results) => {
           assert(Array.isArray(results))
           assert(results.length > 0)
-          const firstType = <CommunicationType>results.pop()
+          const firstType = results.pop()
           assert(firstType.id)
           assert(firstType.description)
           assert(firstType._info)
@@ -319,7 +315,7 @@ describe('utils', () => {
 
     it('should resolve an array of results', (done) => {
       utils.Series.all({ series: [new Promise((resolve) => resolve(true))] })
-        .then((results): void => {
+        .then((results) => {
           assert(results[0] === true)
           done()
         })
@@ -328,7 +324,7 @@ describe('utils', () => {
 
     it('should resolve an array of results', (done) => {
       utils.Series.all({ series: [() => true] })
-        .then((results): void => {
+        .then((results) => {
           assert(results[0] === true)
           done()
         })
@@ -339,7 +335,7 @@ describe('utils', () => {
       utils.Series.all({
         series: [() => new Promise((resolve) => resolve(true))],
       })
-        .then((results): void => {
+        .then((results) => {
           assert(results[0] === true)
           done()
         })

package/test/test-utils.ts

@@ -1,27 +0,0 @@
-export type PromiseArray<T> = Array<Promise<T>>
-
-export function isPromise(input: unknown): input is Promise<unknown> {
-  return (
-    !!input &&
-    (typeof input === 'object' || typeof input === 'function') &&
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    typeof input.then === 'function'
-  )
-}
-
-export function isPromiseType(input: unknown): input is Promise<unknown> {
-  return isPromise(input)
-}
-
-export function isArrayOfPromises(input: unknown): input is PromiseArray<unknown> {
-  if (Array.isArray(input)) {
-    if (Array.length === 0) {
-      return true
-    }
-    if (isPromise(input.pop)) {
-      return true
-    }
-  }
-  return false
-}