connectwise-rest 1.0.0 → 1.0.1

package/src/Automate/RemoteAgentAPI.ts

@@ -5,13 +5,20 @@ import { CommonParameters, CWAOptions } from '../AutomateAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 type requestBodies = components['requestBodies']
+/** {@link LabTechModelsRemoteAgentSchedule} */
 export type LabTechModelsRemoteAgentSchedule = schemas['LabTech.Models.RemoteAgentSchedule']
+/** {@link LabTechModelsRemoteAgentTemplate} */
 export type LabTechModelsRemoteAgentTemplate = schemas['LabTech.Models.RemoteAgentTemplate']
 
 /**
+ * @module RemoteAgentAPI
+ */
+
+/**
+ * RemoteAgent module
  * @public
  */
-export default class RemoteAgentAPI extends Automate {
+export class RemoteAgentAPI extends Automate {
   constructor(props: CWAOptions) {
     super(props)
   }

package/src/Automate/ScriptingAPI.ts

@@ -5,19 +5,29 @@ import { CommonParameters, CWAOptions } from '../AutomateAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 type requestBodies = components['requestBodies']
+/** {@link AutomateApiDomainContractsScriptsRunningScriptsRunningScript} */
 export type AutomateApiDomainContractsScriptsRunningScriptsRunningScript =
   schemas['Automate.Api.Domain.Contracts.Scripts.RunningScripts.RunningScript']
+/** {@link AutomateApiDomainContractsScriptsScheduledScript} */
 export type AutomateApiDomainContractsScriptsScheduledScript =
   schemas['Automate.Api.Domain.Contracts.Scripts.ScheduledScript']
+/** {@link LabTechModelsScript} */
 export type LabTechModelsScript = schemas['LabTech.Models.Script']
+/** {@link LabTechModelsScriptFolder} */
 export type LabTechModelsScriptFolder = schemas['LabTech.Models.ScriptFolder']
+/** {@link LabTechRESTApiModelsPatchOperationArray} */
 export type LabTechRESTApiModelsPatchOperationArray =
   requestBodies['LabTech.RESTApi.Models.PatchOperationArray']
 
 /**
+ * @module ScriptingAPI
+ */
+
+/**
+ * Scripting module
  * @public
  */
-export default class ScriptingAPI extends Automate {
+export class ScriptingAPI extends Automate {
   constructor(props: CWAOptions) {
     super(props)
   }

package/src/Automate/SearchesAPI.ts

@@ -5,13 +5,20 @@ import { CommonParameters, CWAOptions } from '../AutomateAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 type requestBodies = components['requestBodies']
+/** {@link LabTechModelsSearch} */
 export type LabTechModelsSearch = schemas['LabTech.Models.Search']
+/** {@link LabTechModelsSearchFolder} */
 export type LabTechModelsSearchFolder = schemas['LabTech.Models.SearchFolder']
 
 /**
+ * @module SearchesAPI
+ */
+
+/**
+ * Searches module
  * @public
  */
-export default class SearchesAPI extends Automate {
+export class SearchesAPI extends Automate {
   constructor(props: CWAOptions) {
     super(props)
   }

package/src/Automate/SystemAPI.ts

@@ -5,58 +5,84 @@ import { CommonParameters, CWAOptions } from '../AutomateAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 type requestBodies = components['requestBodies']
+/** {@link AutomateApiDomainContractsPresentationLayerWebExtensionsUserClassWebExtensionRequest} */
 export type AutomateApiDomainContractsPresentationLayerWebExtensionsUserClassWebExtensionRequest =
   schemas['Automate.Api.Domain.Contracts.PresentationLayer.WebExtensions.UserClassWebExtensionRequest']
+/** {@link AutomateApiDomainContractsPresentationLayerWebExtensionsUserClassWebExtensionViewModel} */
 export type AutomateApiDomainContractsPresentationLayerWebExtensionsUserClassWebExtensionViewModel =
   schemas['Automate.Api.Domain.Contracts.PresentationLayer.WebExtensions.UserClassWebExtensionViewModel']
+/** {@link AutomateApiDomainContractsSecurityAuthInformation} */
 export type AutomateApiDomainContractsSecurityAuthInformation =
   schemas['Automate.Api.Domain.Contracts.Security.AuthInformation']
+/** {@link AutomateApiDomainContractsSecurityTokenCredentials} */
 export type AutomateApiDomainContractsSecurityTokenCredentials =
   schemas['Automate.Api.Domain.Contracts.Security.TokenCredentials']
+/** {@link AutomateApiDomainContractsSecurityTokenResult} */
 export type AutomateApiDomainContractsSecurityTokenResult =
   schemas['Automate.Api.Domain.Contracts.Security.TokenResult']
+/** {@link AutomateApiDomainContractsSystemServerInformation} */
 export type AutomateApiDomainContractsSystemServerInformation =
   schemas['Automate.Api.Domain.Contracts.System.ServerInformation']
+/** {@link AutomateApiDomainContractsUsersChangePasswordRequest} */
 export type AutomateApiDomainContractsUsersChangePasswordRequest =
   schemas['Automate.Api.Domain.Contracts.Users.ChangePasswordRequest']
+/** {@link AutomateApiDomainContractsUsersUser} */
 export type AutomateApiDomainContractsUsersUser =
   schemas['Automate.Api.Domain.Contracts.Users.User']
+/** {@link AutomateApiDomainContractsUsersUserAccess} */
 export type AutomateApiDomainContractsUsersUserAccess =
   schemas['Automate.Api.Domain.Contracts.Users.UserAccess']
+/** {@link AutomateApiDomainContractsUsersUserClass} */
 export type AutomateApiDomainContractsUsersUserClass =
   schemas['Automate.Api.Domain.Contracts.Users.UserClass']
+/** {@link AutomateApiDomainContractsUsersUserFolder} */
 export type AutomateApiDomainContractsUsersUserFolder =
   schemas['Automate.Api.Domain.Contracts.Users.UserFolder']
+/** {@link LabTechModelsExternalSystemCredentials} */
 export type LabTechModelsExternalSystemCredentials =
   schemas['LabTech.Models.ExternalSystemCredentials']
+/** {@link LabTechModelsFeatureFlag} */
 export type LabTechModelsFeatureFlag = schemas['LabTech.Models.FeatureFlag']
+/** {@link LabTechModelsLicensedProduct} */
 export type LabTechModelsLicensedProduct = schemas['LabTech.Models.LicensedProduct']
+/** {@link LabTechModelsLink} */
 export type LabTechModelsLink = schemas['LabTech.Models.Link']
+/** {@link LabTechModelsPatchInformation} */
 export type LabTechModelsPatchInformation = schemas['LabTech.Models.PatchInformation']
+/** {@link LabTechModelsUserAudit} */
 export type LabTechModelsUserAudit = schemas['LabTech.Models.UserAudit']
+/** {@link LabTechModelsUserFavorite} */
 export type LabTechModelsUserFavorite = schemas['LabTech.Models.UserFavorite']
+/** {@link LabTechModelsUserSetting} */
 export type LabTechModelsUserSetting = schemas['LabTech.Models.UserSetting']
+/** {@link LabTechRESTApiModelsPatchOperationArray} */
 export type LabTechRESTApiModelsPatchOperationArray =
   requestBodies['LabTech.RESTApi.Models.PatchOperationArray']
+/** {@link LabTechRESTApiSecurityAuthServiceCredentials} */
 export type LabTechRESTApiSecurityAuthServiceCredentials =
   schemas['LabTech.RESTApi.Security.AuthServiceCredentials']
 
 /**
+ * @module SystemAPI
+ */
+
+/**
+ * System module
  * @public
  */
-export default class SystemAPI extends Automate {
+export class SystemAPI extends Automate {
   constructor(props: CWAOptions) {
     super(props)
   }
 
-  get(): Promise<AutomateApiDomainContractsSecurityAuthInformation> {
+  getAuthInformation(): Promise<AutomateApiDomainContractsSecurityAuthInformation> {
     return this.request({
       path: `/api/v1/APIToken`,
       method: 'get',
     })
   }
 
-  post(
+  postToken(
     TokenCredentials: AutomateApiDomainContractsSecurityTokenCredentials,
   ): Promise<AutomateApiDomainContractsSecurityTokenResult> {
     return this.request({

package/src/Automate/TicketsAPI.ts

@@ -7,9 +7,14 @@ type schemas = components['schemas']
 type requestBodies = components['requestBodies']
 
 /**
+ * @module TicketsAPI
+ */
+
+/**
+ * Tickets module
  * @public
  */
-export default class TicketsAPI extends Automate {
+export class TicketsAPI extends Automate {
   constructor(props: CWAOptions) {
     super(props)
   }

package/src/Automate/UserProfilesAPI.ts

@@ -5,13 +5,19 @@ import { CommonParameters, CWAOptions } from '../AutomateAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 type requestBodies = components['requestBodies']
+/** {@link LabTechRepositoriesMySQLDomainModelsPresentationLayerUserProfile} */
 export type LabTechRepositoriesMySQLDomainModelsPresentationLayerUserProfile =
   schemas['LabTech.Repositories.MySQL.Domain.Models.PresentationLayer.UserProfile']
 
 /**
+ * @module UserProfilesAPI
+ */
+
+/**
+ * UserProfiles module
  * @public
  */
-export default class UserProfilesAPI extends Automate {
+export class UserProfilesAPI extends Automate {
   constructor(props: CWAOptions) {
     super(props)
   }

package/src/Automate.ts

@@ -140,18 +140,6 @@ export default class Automate {
     return result.data
   }
 
-  static async refreshToken({
-    username,
-    password,
-    serverUrl,
-  }: {
-    username: string
-    password: string
-    serverUrl: string
-  }) {
-    // @todo how
-  }
-
   async verifyToken() {
     try {
       const result = await this.api({ path: '/api/v1/FeatureFlags', method: 'get' })

package/src/AutomateAPI.ts

@@ -1,46 +1,44 @@
 import Automate from './Automate'
 import { CWLogger, RetryOptions } from './types'
-import AVTemplatePoliciesAPI from './Automate/AVTemplatePoliciesAPI'
-import ClientsAPI from './Automate/ClientsAPI'
-import CommandsAPI from './Automate/CommandsAPI'
-import ComputersAPI from './Automate/ComputersAPI'
-import ContactsAPI from './Automate/ContactsAPI'
-import DataViewsAPI from './Automate/DataViewsAPI'
-import DrivesAPI from './Automate/DrivesAPI'
-import EventLogsAPI from './Automate/EventLogsAPI'
-import LocationsAPI from './Automate/LocationsAPI'
-import MaintenanceWindowDefinitionsAPI from './Automate/MaintenanceWindowDefinitionsAPI'
-import MonitorsAPI from './Automate/MonitorsAPI'
-import NetworkDevicesAPI from './Automate/NetworkDevicesAPI'
-import PatchingAPI from './Automate/PatchingAPI'
-import RemoteAgentAPI from './Automate/RemoteAgentAPI'
-import ScriptingAPI from './Automate/ScriptingAPI'
-import SearchesAPI from './Automate/SearchesAPI'
-import SystemAPI from './Automate/SystemAPI'
-import TicketAPI from './Automate/TicketsAPI'
-import UserProfilesAPI from './Automate/UserProfilesAPI'
+import { AVTemplatePoliciesAPI } from './Automate/AVTemplatePoliciesAPI'
+import { ClientsAPI } from './Automate/ClientsAPI'
+import { CommandsAPI } from './Automate/CommandsAPI'
+import { ComputersAPI } from './Automate/ComputersAPI'
+import { ContactsAPI } from './Automate/ContactsAPI'
+import { DataViewsAPI } from './Automate/DataViewsAPI'
+import { DrivesAPI } from './Automate/DrivesAPI'
+import { EventLogsAPI } from './Automate/EventLogsAPI'
+import { LocationsAPI } from './Automate/LocationsAPI'
+import { MaintenanceWindowDefinitionsAPI } from './Automate/MaintenanceWindowDefinitionsAPI'
+import { MonitorsAPI } from './Automate/MonitorsAPI'
+import { NetworkDevicesAPI } from './Automate/NetworkDevicesAPI'
+import { PatchingAPI } from './Automate/PatchingAPI'
+import { RemoteAgentAPI } from './Automate/RemoteAgentAPI'
+import { ScriptingAPI } from './Automate/ScriptingAPI'
+import { SearchesAPI } from './Automate/SearchesAPI'
+import { SystemAPI } from './Automate/SystemAPI'
+import { TicketsAPI } from './Automate/TicketsAPI'
+import { UserProfilesAPI } from './Automate/UserProfilesAPI'
 
-export type {
-  AVTemplatePoliciesAPI,
-  ClientsAPI,
-  CommandsAPI,
-  ComputersAPI,
-  ContactsAPI,
-  DataViewsAPI,
-  DrivesAPI,
-  EventLogsAPI,
-  LocationsAPI,
-  MaintenanceWindowDefinitionsAPI,
-  MonitorsAPI,
-  NetworkDevicesAPI,
-  PatchingAPI,
-  RemoteAgentAPI,
-  ScriptingAPI,
-  SearchesAPI,
-  SystemAPI,
-  TicketAPI,
-  UserProfilesAPI,
-}
+import type * as AVTemplatePoliciesAPITypes from './Automate/AVTemplatePoliciesAPI'
+import type * as ClientsAPITypes from './Automate/ClientsAPI'
+import type * as CommandsAPITypes from './Automate/CommandsAPI'
+import type * as ComputersAPITypes from './Automate/ComputersAPI'
+import type * as ContactsAPITypes from './Automate/ContactsAPI'
+import type * as DataViewsAPITypes from './Automate/DataViewsAPI'
+import type * as DrivesAPITypes from './Automate/DrivesAPI'
+import type * as EventLogsAPITypes from './Automate/EventLogsAPI'
+import type * as LocationsAPITypes from './Automate/LocationsAPI'
+import type * as MaintenanceWindowDefinitionsAPITypes from './Automate/MaintenanceWindowDefinitionsAPI'
+import type * as MonitorsAPITypes from './Automate/MonitorsAPI'
+import type * as NetworkDevicesAPITypes from './Automate/NetworkDevicesAPI'
+import type * as PatchingAPITypes from './Automate/PatchingAPI'
+import type * as RemoteAgentAPITypes from './Automate/RemoteAgentAPI'
+import type * as ScriptingAPITypes from './Automate/ScriptingAPI'
+import type * as SearchesAPITypes from './Automate/SearchesAPI'
+import type * as SystemAPITypes from './Automate/SystemAPI'
+import type * as TicketsAPITypes from './Automate/TicketsAPI'
+import type * as UserProfilesAPITypes from './Automate/UserProfilesAPI'
 
 /**
  * @public
@@ -59,6 +57,9 @@ export type CWAOptions = {
   debug?: boolean
 }
 
+/**
+ * @public
+ */
 export type OrderBy = {
   name?: string
   type?: 'Undefined' | 'Ascending' | 'Descending'
@@ -81,6 +82,9 @@ export type CommonParameters = {
   timeout?: number
 }
 
+/**
+ * @public
+ */
 export type QueryOptionExpand = {
   fieldName?: string
   page?: number
@@ -95,9 +99,13 @@ export type QueryOptionExpand = {
 }
 
 /**
+ * @module AutomateAPI
  * @public
  */
-export default class AutomateAPI extends Automate {
+class AutomateAPI extends Automate {
+  /**
+   * @public
+   */
   AVTemplatePoliciesAPI: AVTemplatePoliciesAPI
   ClientsAPI: ClientsAPI
   CommandsAPI: CommandsAPI
@@ -115,7 +123,7 @@ export default class AutomateAPI extends Automate {
   ScriptingAPI: ScriptingAPI
   SearchesAPI: SearchesAPI
   SystemAPI: SystemAPI
-  TicketAPI: TicketAPI
+  TicketsAPI: TicketsAPI
   UserProfilesAPI: UserProfilesAPI
 
   constructor(options: CWAOptions) {
@@ -138,7 +146,33 @@ export default class AutomateAPI extends Automate {
     this.ScriptingAPI = new ScriptingAPI(options)
     this.SearchesAPI = new SearchesAPI(options)
     this.SystemAPI = new SystemAPI(options)
-    this.TicketAPI = new TicketAPI(options)
+    this.TicketsAPI = new TicketsAPI(options)
     this.UserProfilesAPI = new UserProfilesAPI(options)
   }
 }
+
+/**
+ * @public
+ */
+export default AutomateAPI
+export type {
+  AVTemplatePoliciesAPITypes,
+  ClientsAPITypes,
+  CommandsAPITypes,
+  ComputersAPITypes,
+  ContactsAPITypes,
+  DataViewsAPITypes,
+  DrivesAPITypes,
+  EventLogsAPITypes,
+  LocationsAPITypes,
+  MaintenanceWindowDefinitionsAPITypes,
+  MonitorsAPITypes,
+  NetworkDevicesAPITypes,
+  PatchingAPITypes,
+  RemoteAgentAPITypes,
+  ScriptingAPITypes,
+  SearchesAPITypes,
+  SystemAPITypes,
+  TicketsAPITypes,
+  UserProfilesAPITypes,
+}

package/src/AutomateTypes.ts

@@ -10,7 +10,7 @@ export interface paths {
     get: operations['Tickets_GetTicketList']
   }
   '/api/v1/APIToken': {
-    get: operations['ApiToken_GetToken']
+    get: operations['ApiToken_Get']
     post: operations['ApiToken_Post']
   }
   '/api/v1/System/ServerInformation': {

package/src/BaseAPI.ts

@@ -2,6 +2,7 @@ import { RequestOptions } from './types'
 import promiseRetry from 'promise-retry'
 import Manage, { ManageConfig } from './Manage'
 import Automate, { AutomateConfig } from './Automate'
+import { CommonParameters } from './AutomateAPI'
 
 /**
  * curried request function
@@ -81,3 +82,99 @@ export const makeRequest =
         })
     }
   }
+
+export interface PaginationConfig {
+  thisObj: InstanceType<typeof Automate | typeof Manage>
+}
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+export type PaginationApiMethod = Function
+
+export type PaginationOptions = {
+  pageSize?: number
+  startPage?: number
+}
+
+/**
+ * curried paginate function
+ * @internal
+ */
+export const makePaginate =
+  ({ thisObj }: PaginationConfig) =>
+  (
+    apiMethod: PaginationApiMethod,
+    paginateArgs: PaginationOptions = {},
+    ...methodArgs: Record<string, unknown>[]
+  ): Promise<unknown[]> => {
+    const { startPage = 0, pageSize = 1000 } = paginateArgs
+
+    return new Promise(async (resolve, reject) => {
+      let results: unknown[] = []
+
+      let page = startPage
+
+      if (startPage === undefined || startPage < 1) {
+        page = 0
+      }
+
+      while (true) {
+        try {
+          const result = await getPage(apiMethod, methodArgs, thisObj, page++, pageSize)
+          // complete page returned, loop again
+          if (Array.isArray(result) && result.length > 0) {
+            results = results.concat(result)
+          } else {
+            // incomplete page, this is the last page of results, exit loop and return
+            break
+          }
+        } catch (error: unknown) {
+          return reject(error)
+        }
+      }
+
+      return resolve(results)
+    })
+  }
+
+/**
+ * @internal
+ */
+function getPage(
+  apiMethod: PaginationApiMethod,
+  methodArgs: Record<string, unknown>[],
+  thisObj: InstanceType<typeof Automate | typeof Manage>,
+  page = 1,
+  pageSize = 1000,
+): Promise<unknown[]> {
+  // Javascript Function.length returns number of non-default values
+  // the method args will always be greater than the api method args
+  // due to this, if params is not passed in, even as an empty object,
+  // we need to throw an error
+  if (methodArgs.length < apiMethod.length) {
+    throw new Error(
+      `CommonParams must be passed in for pagination to work properly for function ${apiMethod.name}`,
+    )
+  }
+
+  // look for CommonParams and inject page and pageSize
+  // check for apiMethod function args length
+  // get last arg
+  const commonParams = <CommonParameters>methodArgs.pop()
+  commonParams.page = page
+  commonParams.pageSize = pageSize
+
+  methodArgs.push(commonParams)
+
+  return apiMethod.apply(thisObj, methodArgs)
+}
+
+/**
+ * @internal
+ */
+function isCommonParametersLike(input: unknown): input is CommonParameters {
+  if (typeof input === 'object' && input !== null) {
+    return true
+  } else {
+    return false
+  }
+}