connectwise-rest 1.0.0 → 1.1.0

package/src/Manage/SystemAPI.ts

@@ -5,152 +5,298 @@ import { CommonParameters, CWMOptions } from '../ManageAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 
+/** {@link AllowedFileType} */
 export type AllowedFileType = schemas['AllowedFileType']
+/** {@link AllowedOrigin} */
 export type AllowedOrigin = schemas['AllowedOrigin']
+/** {@link ApiMember} */
 export type ApiMember = schemas['ApiMember']
+/** {@link AuditTrailEntry} */
 export type AuditTrailEntry = schemas['AuditTrailEntry']
+/** {@link AuthAnvil} */
 export type AuthAnvil = schemas['AuthAnvil']
+/** {@link AutoSyncTime} */
 export type AutoSyncTime = schemas['AutoSyncTime']
+/** {@link BulkResult} */
 export type BulkResult = schemas['BulkResult']
+/** {@link BundleRequestsCollection} */
 export type BundleRequestsCollection = schemas['BundleRequestsCollection']
+/** {@link BundleResultsCollection} */
 export type BundleResultsCollection = schemas['BundleResultsCollection']
+/** {@link CallbackEntry} */
 export type CallbackEntry = schemas['CallbackEntry']
+/** {@link Certification} */
 export type Certification = schemas['Certification']
+/** {@link ConnectWiseHostedScreen} */
 export type ConnectWiseHostedScreen = schemas['ConnectWiseHostedScreen']
+/** {@link ConnectWiseHostedSetup} */
 export type ConnectWiseHostedSetup = schemas['ConnectWiseHostedSetup']
+/** {@link CorporateStructure} */
 export type CorporateStructure = schemas['CorporateStructure']
+/** {@link CorporateStructureInfo} */
 export type CorporateStructureInfo = schemas['CorporateStructureInfo']
+/** {@link CorporateStructureLevel} */
 export type CorporateStructureLevel = schemas['CorporateStructureLevel']
+/** {@link Count} */
 export type Count = schemas['Count']
+/** {@link Crm} */
 export type Crm = schemas['Crm']
+/** {@link CrmInfo} */
 export type CrmInfo = schemas['CrmInfo']
+/** {@link CustomReport} */
 export type CustomReport = schemas['CustomReport']
+/** {@link CustomReportParameter} */
 export type CustomReportParameter = schemas['CustomReportParameter']
+/** {@link CwTimeZone} */
 export type CwTimeZone = schemas['CwTimeZone']
+/** {@link Department} */
 export type Department = schemas['Department']
+/** {@link DepartmentInfo} */
 export type DepartmentInfo = schemas['DepartmentInfo']
+/** {@link DepartmentLocation} */
 export type DepartmentLocation = schemas['DepartmentLocation']
+/** {@link DepartmentLocationInfo} */
 export type DepartmentLocationInfo = schemas['DepartmentLocationInfo']
+/** {@link DocumentFormData} */
 export type DocumentFormData = schemas['DocumentFormData']
+/** {@link DocumentInfo} */
 export type DocumentInfo = schemas['DocumentInfo']
+/** {@link DocumentSetup} */
 export type DocumentSetup = schemas['DocumentSetup']
+/** {@link EPayConfiguration} */
 export type EPayConfiguration = schemas['EPayConfiguration']
+/** {@link EmailConnector} */
 export type EmailConnector = schemas['EmailConnector']
+/** {@link EmailConnectorInfo} */
 export type EmailConnectorInfo = schemas['EmailConnectorInfo']
+/** {@link EmailConnectorParsingRule} */
 export type EmailConnectorParsingRule = schemas['EmailConnectorParsingRule']
+/** {@link EmailConnectorParsingStyle} */
 export type EmailConnectorParsingStyle = schemas['EmailConnectorParsingStyle']
+/** {@link EmailExclusion} */
 export type EmailExclusion = schemas['EmailExclusion']
+/** {@link EmailToken} */
 export type EmailToken = schemas['EmailToken']
+/** {@link Experiment} */
 export type Experiment = schemas['Experiment']
+/** {@link FileUploadSetting} */
 export type FileUploadSetting = schemas['FileUploadSetting']
+/** {@link GoogleEmailSetup} */
 export type GoogleEmailSetup = schemas['GoogleEmailSetup']
+/** {@link IdCollection} */
 export type IdCollection = schemas['IdCollection']
+/** {@link Imap} */
 export type Imap = schemas['Imap']
+/** {@link ImapInfo} */
 export type ImapInfo = schemas['ImapInfo']
+/** {@link ImportMassMaintenance} */
 export type ImportMassMaintenance = schemas['ImportMassMaintenance']
+/** {@link InOutBoard} */
 export type InOutBoard = schemas['InOutBoard']
+/** {@link InOutType} */
 export type InOutType = schemas['InOutType']
+/** {@link InOutTypeInfo} */
 export type InOutTypeInfo = schemas['InOutTypeInfo']
+/** {@link Info} */
 export type Info = schemas['Info']
+/** {@link IntegratorLogin} */
 export type IntegratorLogin = schemas['IntegratorLogin']
+/** {@link IntegratorTag} */
 export type IntegratorTag = schemas['IntegratorTag']
+/** {@link KPI} */
 export type KPI = schemas['KPI']
+/** {@link KPICategory} */
 export type KPICategory = schemas['KPICategory']
+/** {@link LdapConfiguration} */
 export type LdapConfiguration = schemas['LdapConfiguration']
+/** {@link LdapConfigurationInfo} */
 export type LdapConfigurationInfo = schemas['LdapConfigurationInfo']
+/** {@link LdapConfigurationTestLink} */
 export type LdapConfigurationTestLink = schemas['LdapConfigurationTestLink']
+/** {@link Link} */
 export type Link = schemas['Link']
+/** {@link LinkInfo} */
 export type LinkInfo = schemas['LinkInfo']
+/** {@link LinkResolveUrlInfo} */
 export type LinkResolveUrlInfo = schemas['LinkResolveUrlInfo']
+/** {@link LocaleInfo} */
 export type LocaleInfo = schemas['LocaleInfo']
+/** {@link Location} */
 export type Location = schemas['Location']
+/** {@link LocationDepartment} */
 export type LocationDepartment = schemas['LocationDepartment']
+/** {@link LocationInfo} */
 export type LocationInfo = schemas['LocationInfo']
+/** {@link LocationWorkRole} */
 export type LocationWorkRole = schemas['LocationWorkRole']
+/** {@link ManagedDeviceAccount} */
 export type ManagedDeviceAccount = schemas['ManagedDeviceAccount']
+/** {@link ManagementNetworkSecurity} */
 export type ManagementNetworkSecurity = schemas['ManagementNetworkSecurity']
+/** {@link MarketplaceImport} */
 export type MarketplaceImport = schemas['MarketplaceImport']
+/** {@link Member} */
 export type Member = schemas['Member']
+/** {@link MemberAccrual} */
 export type MemberAccrual = schemas['MemberAccrual']
+/** {@link MemberCertification} */
 export type MemberCertification = schemas['MemberCertification']
+/** {@link MemberDeactivation} */
 export type MemberDeactivation = schemas['MemberDeactivation']
+/** {@link MemberDelegation} */
 export type MemberDelegation = schemas['MemberDelegation']
+/** {@link MemberInfo} */
 export type MemberInfo = schemas['MemberInfo']
+/** {@link MemberLinkSsoUser} */
 export type MemberLinkSsoUser = schemas['MemberLinkSsoUser']
+/** {@link MemberNotificationSetting} */
 export type MemberNotificationSetting = schemas['MemberNotificationSetting']
+/** {@link MemberPersona} */
 export type MemberPersona = schemas['MemberPersona']
+/** {@link MemberSkill} */
 export type MemberSkill = schemas['MemberSkill']
+/** {@link MemberSsoToken} */
 export type MemberSsoToken = schemas['MemberSsoToken']
+/** {@link MemberType} */
 export type MemberType = schemas['MemberType']
+/** {@link MemberTypeInfo} */
 export type MemberTypeInfo = schemas['MemberTypeInfo']
+/** {@link MenuEntry} */
 export type MenuEntry = schemas['MenuEntry']
+/** {@link MenuEntryLocation} */
 export type MenuEntryLocation = schemas['MenuEntryLocation']
+/** {@link MyAccount} */
 export type MyAccount = schemas['MyAccount']
+/** {@link MyMember} */
 export type MyMember = schemas['MyMember']
+/** {@link MyMemberInfo} */
 export type MyMemberInfo = schemas['MyMemberInfo']
+/** {@link MySecurity} */
 export type MySecurity = schemas['MySecurity']
+/** {@link MySecurityCustomizeItem} */
 export type MySecurityCustomizeItem = schemas['MySecurityCustomizeItem']
+/** {@link NotificationRecipient} */
 export type NotificationRecipient = schemas['NotificationRecipient']
+/** {@link Office365EmailSetup} */
 export type Office365EmailSetup = schemas['Office365EmailSetup']
+/** {@link OsGradeWeight} */
 export type OsGradeWeight = schemas['OsGradeWeight']
+/** {@link Other} */
 export type Other = schemas['Other']
+/** {@link ParsingType} */
 export type ParsingType = schemas['ParsingType']
+/** {@link ParsingVariable} */
 export type ParsingVariable = schemas['ParsingVariable']
+/** {@link PatchOperation} */
 export type PatchOperation = schemas['PatchOperation']
+/** {@link PersonasInfo} */
 export type PersonasInfo = schemas['PersonasInfo']
+/** {@link PortalReport} */
 export type PortalReport = schemas['PortalReport']
+/** {@link QuoteLink} */
 export type QuoteLink = schemas['QuoteLink']
+/** {@link Report} */
 export type Report = schemas['Report']
+/** {@link ReportCard} */
 export type ReportCard = schemas['ReportCard']
+/** {@link ReportCardDetail} */
 export type ReportCardDetail = schemas['ReportCardDetail']
+/** {@link ReportCardInfo} */
 export type ReportCardInfo = schemas['ReportCardInfo']
+/** {@link ReportColumnDefinition} */
 export type ReportColumnDefinition = schemas['ReportColumnDefinition']
+/** {@link ReportDataResponse} */
 export type ReportDataResponse = schemas['ReportDataResponse']
+/** {@link ReportingService} */
 export type ReportingService = schemas['ReportingService']
+/** {@link SecurityRole} */
 export type SecurityRole = schemas['SecurityRole']
+/** {@link SecurityRoleInfo} */
 export type SecurityRoleInfo = schemas['SecurityRoleInfo']
+/** {@link SecurityRoleSetting} */
 export type SecurityRoleSetting = schemas['SecurityRoleSetting']
+/** {@link Service} */
 export type Service = schemas['Service']
+/** {@link ServiceInfo} */
 export type ServiceInfo = schemas['ServiceInfo']
+/** {@link SetupScreen} */
 export type SetupScreen = schemas['SetupScreen']
+/** {@link Skill} */
 export type Skill = schemas['Skill']
+/** {@link SkillCategory} */
 export type SkillCategory = schemas['SkillCategory']
+/** {@link SkillInfo} */
 export type SkillInfo = schemas['SkillInfo']
+/** {@link SsoConfiguration} */
 export type SsoConfiguration = schemas['SsoConfiguration']
+/** {@link SsoUser} */
 export type SsoUser = schemas['SsoUser']
+/** {@link StandardNote} */
 export type StandardNote = schemas['StandardNote']
+/** {@link StandardNoteInfo} */
 export type StandardNoteInfo = schemas['StandardNoteInfo']
+/** {@link SuccessResponse} */
 export type SuccessResponse = schemas['SuccessResponse']
+/** {@link Survey} */
 export type Survey = schemas['Survey']
+/** {@link SurveyInfo} */
 export type SurveyInfo = schemas['SurveyInfo']
+/** {@link SurveyQuestion} */
 export type SurveyQuestion = schemas['SurveyQuestion']
+/** {@link SurveyQuestionValue} */
 export type SurveyQuestionValue = schemas['SurveyQuestionValue']
+/** {@link SystemSetting} */
 export type SystemSetting = schemas['SystemSetting']
+/** {@link TimeExpense} */
 export type TimeExpense = schemas['TimeExpense']
+/** {@link TimeZoneSetup} */
 export type TimeZoneSetup = schemas['TimeZoneSetup']
+/** {@link TimeZoneSetupInfo} */
 export type TimeZoneSetupInfo = schemas['TimeZoneSetupInfo']
+/** {@link TodayPageCategory} */
 export type TodayPageCategory = schemas['TodayPageCategory']
+/** {@link Token} */
 export type Token = schemas['Token']
+/** {@link Usage} */
 export type Usage = schemas['Usage']
+/** {@link UserDefinedField} */
 export type UserDefinedField = schemas['UserDefinedField']
+/** {@link UserDefinedFieldInfo} */
 export type UserDefinedFieldInfo = schemas['UserDefinedFieldInfo']
+/** {@link Workflow} */
 export type Workflow = schemas['Workflow']
+/** {@link WorkflowAction} */
 export type WorkflowAction = schemas['WorkflowAction']
+/** {@link WorkflowActionAutomateParameter} */
 export type WorkflowActionAutomateParameter = schemas['WorkflowActionAutomateParameter']
+/** {@link WorkflowActionUserDefinedField} */
 export type WorkflowActionUserDefinedField = schemas['WorkflowActionUserDefinedField']
+/** {@link WorkflowAttachment} */
 export type WorkflowAttachment = schemas['WorkflowAttachment']
+/** {@link WorkflowEvent} */
 export type WorkflowEvent = schemas['WorkflowEvent']
+/** {@link WorkflowNotifyType} */
 export type WorkflowNotifyType = schemas['WorkflowNotifyType']
+/** {@link WorkflowNotifyTypeInfo} */
 export type WorkflowNotifyTypeInfo = schemas['WorkflowNotifyTypeInfo']
+/** {@link WorkflowTableType} */
 export type WorkflowTableType = schemas['WorkflowTableType']
+/** {@link WorkflowTableTypeInfo} */
 export type WorkflowTableTypeInfo = schemas['WorkflowTableTypeInfo']
+/** {@link WorkflowTrigger} */
 export type WorkflowTrigger = schemas['WorkflowTrigger']
+/** {@link WorkflowTriggerOption} */
 export type WorkflowTriggerOption = schemas['WorkflowTriggerOption']
 
 /**
+ * @module SystemAPI
+ */
+
+/**
+ * System module
  * @public
  */
-export default class SystemAPI extends Manage {
+export class SystemAPI extends Manage {
   constructor(props: CWMOptions) {
     super(props)
   }

package/src/Manage/TimeAPI.ts

@@ -5,36 +5,66 @@ import { CommonParameters, CWMOptions } from '../ManageAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 
+/** {@link ActivityStopwatch} */
 export type ActivityStopwatch = schemas['ActivityStopwatch']
+/** {@link ChargeCode} */
 export type ChargeCode = schemas['ChargeCode']
+/** {@link ChargeCodeExpenseType} */
 export type ChargeCodeExpenseType = schemas['ChargeCodeExpenseType']
+/** {@link ChargeCodeInfo} */
 export type ChargeCodeInfo = schemas['ChargeCodeInfo']
+/** {@link Count} */
 export type Count = schemas['Count']
+/** {@link PatchOperation} */
 export type PatchOperation = schemas['PatchOperation']
+/** {@link ScheduleStopwatch} */
 export type ScheduleStopwatch = schemas['ScheduleStopwatch']
+/** {@link SuccessResponse} */
 export type SuccessResponse = schemas['SuccessResponse']
+/** {@link TicketStopwatch} */
 export type TicketStopwatch = schemas['TicketStopwatch']
+/** {@link TimeAccrual} */
 export type TimeAccrual = schemas['TimeAccrual']
+/** {@link TimeAccrualDetail} */
 export type TimeAccrualDetail = schemas['TimeAccrualDetail']
+/** {@link TimeEntry} */
 export type TimeEntry = schemas['TimeEntry']
+/** {@link TimeEntryAudit} */
 export type TimeEntryAudit = schemas['TimeEntryAudit']
+/** {@link TimePeriod} */
 export type TimePeriod = schemas['TimePeriod']
+/** {@link TimePeriodSetup} */
 export type TimePeriodSetup = schemas['TimePeriodSetup']
+/** {@link TimePeriodSetupDefaults} */
 export type TimePeriodSetupDefaults = schemas['TimePeriodSetupDefaults']
+/** {@link TimeSheet} */
 export type TimeSheet = schemas['TimeSheet']
+/** {@link TimeSheetAudit} */
 export type TimeSheetAudit = schemas['TimeSheetAudit']
+/** {@link TimeSheetTierUpdate} */
 export type TimeSheetTierUpdate = schemas['TimeSheetTierUpdate']
+/** {@link Usage} */
 export type Usage = schemas['Usage']
+/** {@link WorkRole} */
 export type WorkRole = schemas['WorkRole']
+/** {@link WorkRoleInfo} */
 export type WorkRoleInfo = schemas['WorkRoleInfo']
+/** {@link WorkRoleLocation} */
 export type WorkRoleLocation = schemas['WorkRoleLocation']
+/** {@link WorkType} */
 export type WorkType = schemas['WorkType']
+/** {@link WorkTypeInfo} */
 export type WorkTypeInfo = schemas['WorkTypeInfo']
 
 /**
+ * @module TimeAPI
+ */
+
+/**
+ * Time module
  * @public
  */
-export default class TimeAPI extends Manage {
+export class TimeAPI extends Manage {
   constructor(props: CWMOptions) {
     super(props)
   }

package/src/Manage.ts

@@ -1,5 +1,5 @@
 import axios, { AxiosError, AxiosInstance, AxiosResponse } from 'axios'
-import { makeRequest } from './BaseAPI'
+import { makeRequest, makePaginate, PaginationOptions, PaginationApiMethod } from './BaseAPI'
 import promiseRetry from 'promise-retry'
 import type { CWMOptions } from './ManageAPI'
 import { CWLogger, DataResponse, ErrorResponse, RequestOptions, RetryOptions } from './types'
@@ -60,11 +60,29 @@ 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,
+    paginateArgs: PaginationOptions,
+    ...methodArgs: Record<string, unknown>[]
+  ) => Promise<unknown[]>
+
   constructor({
     companyId,
     publicKey,
@@ -116,6 +134,7 @@ export default class Manage {
     })
 
     this.request = makeRequest({ config: this.config, api: this.api, thisObj: this })
+    this.paginate = makePaginate({ thisObj: this })
   }
 
   /**
@@ -137,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/ManageAPI.ts

@@ -1,39 +1,44 @@
 import Manage from './Manage'
-import CompanyAPI from './Manage/CompanyAPI'
-import ConfigurationsAPI from './Manage/ConfigurationsAPI'
-import ExpenseAPI from './Manage/ExpenseAPI'
-import FinanceAPI from './Manage/FinanceAPI'
-import MarketingAPI from './Manage/MarketingAPI'
-import ProcurementAPI from './Manage/ProcurementAPI'
-import ProjectAPI from './Manage/ProjectAPI'
-import SalesAPI from './Manage/SalesAPI'
-import ScheduleAPI from './Manage/ScheduleAPI'
-import ServiceAPI from './Manage/ServiceAPI'
-import SystemAPI from './Manage/SystemAPI'
-import TimeAPI from './Manage/TimeAPI'
+import { CompanyAPI } from './Manage/CompanyAPI'
+import { ConfigurationsAPI } from './Manage/ConfigurationsAPI'
+import { ExpenseAPI } from './Manage/ExpenseAPI'
+import { FinanceAPI } from './Manage/FinanceAPI'
+import { MarketingAPI } from './Manage/MarketingAPI'
+import { ProcurementAPI } from './Manage/ProcurementAPI'
+import { ProjectAPI } from './Manage/ProjectAPI'
+import { SalesAPI } from './Manage/SalesAPI'
+import { ScheduleAPI } from './Manage/ScheduleAPI'
+import { ServiceAPI } from './Manage/ServiceAPI'
+import { SystemAPI } from './Manage/SystemAPI'
+import { TimeAPI } from './Manage/TimeAPI'
+import type * as CompanyAPITypes from './Manage/CompanyAPI'
+import type * as ConfigurationsAPITypes from './Manage/ConfigurationsAPI'
+import type * as ExpenseAPITypes from './Manage/ExpenseAPI'
+import type * as FinanceAPITypes from './Manage/FinanceAPI'
+import type * as MarketingAPITypes from './Manage/MarketingAPI'
+import type * as ProcurementAPITypes from './Manage/ProcurementAPI'
+import type * as ProjectAPITypes from './Manage/ProjectAPI'
+import type * as SalesAPITypes from './Manage/SalesAPI'
+import type * as ScheduleAPITypes from './Manage/ScheduleAPI'
+import type * as ServiceAPITypes from './Manage/ServiceAPI'
+import type * as SystemAPITypes from './Manage/SystemAPI'
+import type * as TimeAPITypes from './Manage/TimeAPI'
 import { CWLogger, RetryOptions } from './types'
 
-export type {
-  CompanyAPI,
-  ConfigurationsAPI,
-  ExpenseAPI,
-  FinanceAPI,
-  MarketingAPI,
-  ProcurementAPI,
-  ProjectAPI,
-  SalesAPI,
-  ScheduleAPI,
-  ServiceAPI,
-  SystemAPI,
-  TimeAPI,
-}
-
+/**
+ * @public
+ * Manage patch operation input object, usually passed in an array of operations
+ */
 export type PatchOperation = {
   op: 'add' | 'replace' | 'remove'
   path: string
   value: Record<string, unknown> | Record<string, unknown>[] | string | null
 }
 
+/**
+ * @public
+ * Manage common parameters
+ */
 export type CommonParameters = {
   conditions?: string
   childConditions?: string
@@ -45,15 +50,21 @@ export type CommonParameters = {
   pageId?: number
 }
 
+/**
+ * @public
+ */
 export interface CWMOptions {
   /**
    * Your CW Manage Company ID
    */
   companyId: string
   /**
-   *
+   * api public key
    */
   publicKey: string
+  /**
+   * api private key
+   */
   privateKey: string
   /**
    * Your CW Manage instance URI
@@ -80,6 +91,9 @@ export interface CWMOptions {
    * Enable automatic retry.  Defaults to false.
    */
   retry?: boolean
+  /**
+   * @see {@link RetryOptions} type
+   */
   retryOptions?: RetryOptions
   /**
    * Pass in a custom logger function, otherwise the default
@@ -100,7 +114,7 @@ export interface CWMOptions {
 /**
  * @public
  */
-export default class ManageAPI extends Manage {
+class ManageAPI extends Manage {
   CompanyAPI: CompanyAPI
   ConfigurationsAPI: ConfigurationsAPI
   ExpenseAPI: ExpenseAPI
@@ -131,3 +145,26 @@ export default class ManageAPI extends Manage {
     this.TimeAPI = new TimeAPI(options)
   }
 }
+
+/**
+ * @public
+ */
+export default ManageAPI
+
+/**
+ * @public
+ */
+export type {
+  CompanyAPITypes,
+  ConfigurationsAPITypes,
+  ExpenseAPITypes,
+  FinanceAPITypes,
+  MarketingAPITypes,
+  ProcurementAPITypes,
+  ProjectAPITypes,
+  SalesAPITypes,
+  ScheduleAPITypes,
+  ServiceAPITypes,
+  SystemAPITypes,
+  TimeAPITypes,
+}

package/src/index.ts

@@ -1,18 +1,13 @@
 import ManageAPI, { CWMOptions, CommonParameters, PatchOperation } from './ManageAPI'
 import AutomateAPI, { CWAOptions } from './AutomateAPI'
 import type * as types from './types'
+import type * as Automate from './AutomateAPI'
+import type * as Manage from './ManageAPI'
 import * as utils from './utils'
-import * as AutomateAPIs from './AutomateAPI'
-import * as ManageAPIs from './ManageAPI'
 
-export type {
-  AutomateAPIs,
-  ManageAPIs,
-  CWMOptions,
-  CommonParameters,
-  PatchOperation,
-  CWAOptions,
-  types,
-}
+export type { CWMOptions, CommonParameters, PatchOperation, CWAOptions, types, Automate, Manage }
 
+/**
+ * @public
+ */
 export { AutomateAPI, ManageAPI, utils }

package/src/types.ts

@@ -1,4 +1,5 @@
-import * as ManageAPI from './ManageAPI'
+import type * as ManageAPIs from './ManageAPI'
+import type * as AutomateApis from './AutomateAPI'
 
 export enum StatusCode {
   OK = 200,
@@ -63,4 +64,5 @@ export type NoContentResponse = undefined
 export type OctetStreamResponse = Buffer
 export type PDFResponse = Blob
 export type HTMLResponse = string
-export type PatchOperation = ManageAPI.PatchOperation
+export type PatchOperation = ManageAPIs.PatchOperation
+export type { ManageAPIs, AutomateApis }

package/src/utils/Callback.ts

@@ -10,6 +10,9 @@ export interface ExpressRequest extends ClientRequest {
   headers: Record<string, string>
 }
 
+/**
+ * @public
+ */
 export type CallbackPayload = {
   Action: string
   CompanyId: string | number

package/src/utils/Series.ts

@@ -10,6 +10,9 @@ export type PromiseLikeFunction =
   | (() => unknown)
   | { then: () => void }
 
+/**
+ * @public
+ */
 export type SeriesOptions = {
   series: Array<PromiseLikeFunction>
   concurrent?: number
@@ -78,6 +81,9 @@ function all({ series = [], concurrent = 1, delay = 0 }: SeriesOptions): Promise
   })
 }
 
+/**
+ * @public
+ */
 const Series = { all }
 
 export default Series