connectwise-rest 1.0.0 → 1.0.1

package/src/Manage/ProjectAPI.ts

@@ -5,43 +5,80 @@ import { CommonParameters, CWMOptions } from '../ManageAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 
+/** {@link ActivityReference} */
 export type ActivityReference = schemas['ActivityReference']
+/** {@link ConfigurationReference} */
 export type ConfigurationReference = schemas['ConfigurationReference']
+/** {@link ConvertItem} */
 export type ConvertItem = schemas['ConvertItem']
+/** {@link Count} */
 export type Count = schemas['Count']
+/** {@link DocumentReference} */
 export type DocumentReference = schemas['DocumentReference']
+/** {@link FilterValues} */
 export type FilterValues = schemas['FilterValues']
+/** {@link PatchOperation} */
 export type PatchOperation = schemas['PatchOperation']
+/** {@link PhaseStatus} */
 export type PhaseStatus = schemas['PhaseStatus']
+/** {@link ProductReference} */
 export type ProductReference = schemas['ProductReference']
+/** {@link Project} */
 export type Project = schemas['Project']
+/** {@link ProjectBoardTeam} */
 export type ProjectBoardTeam = schemas['ProjectBoardTeam']
+/** {@link ProjectBoardTeamInfo} */
 export type ProjectBoardTeamInfo = schemas['ProjectBoardTeamInfo']
+/** {@link ProjectBoardTeamMember} */
 export type ProjectBoardTeamMember = schemas['ProjectBoardTeamMember']
+/** {@link ProjectContact} */
 export type ProjectContact = schemas['ProjectContact']
+/** {@link ProjectNote} */
 export type ProjectNote = schemas['ProjectNote']
+/** {@link ProjectPhase} */
 export type ProjectPhase = schemas['ProjectPhase']
+/** {@link ProjectSecurityRole} */
 export type ProjectSecurityRole = schemas['ProjectSecurityRole']
+/** {@link ProjectSecurityRoleSetting} */
 export type ProjectSecurityRoleSetting = schemas['ProjectSecurityRoleSetting']
+/** {@link ProjectStatus} */
 export type ProjectStatus = schemas['ProjectStatus']
+/** {@link ProjectStatusInfo} */
 export type ProjectStatusInfo = schemas['ProjectStatusInfo']
+/** {@link ProjectTeamMember} */
 export type ProjectTeamMember = schemas['ProjectTeamMember']
+/** {@link ProjectTicket} */
 export type ProjectTicket = schemas['ProjectTicket']
+/** {@link ProjectTicketNote} */
 export type ProjectTicketNote = schemas['ProjectTicketNote']
+/** {@link ProjectType} */
 export type ProjectType = schemas['ProjectType']
+/** {@link ProjectTypeInfo} */
 export type ProjectTypeInfo = schemas['ProjectTypeInfo']
+/** {@link ScheduleEntryReference} */
 export type ScheduleEntryReference = schemas['ScheduleEntryReference']
+/** {@link StatusIndicator} */
 export type StatusIndicator = schemas['StatusIndicator']
+/** {@link SuccessResponse} */
 export type SuccessResponse = schemas['SuccessResponse']
+/** {@link TicketNote} */
 export type TicketNote = schemas['TicketNote']
+/** {@link TicketTask} */
 export type TicketTask = schemas['TicketTask']
+/** {@link TimeEntryReference} */
 export type TimeEntryReference = schemas['TimeEntryReference']
+/** {@link Usage} */
 export type Usage = schemas['Usage']
 
 /**
+ * @module ProjectAPI
+ */
+
+/**
+ * Project module
  * @public
  */
-export default class ProjectAPI extends Manage {
+export class ProjectAPI extends Manage {
   constructor(props: CWMOptions) {
     super(props)
   }

package/src/Manage/SalesAPI.ts

@@ -5,52 +5,98 @@ import { CommonParameters, CWMOptions } from '../ManageAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 
+/** {@link Activity} */
 export type Activity = schemas['Activity']
+/** {@link ActivityStatus} */
 export type ActivityStatus = schemas['ActivityStatus']
+/** {@link ActivityStatusInfo} */
 export type ActivityStatusInfo = schemas['ActivityStatusInfo']
+/** {@link ActivityType} */
 export type ActivityType = schemas['ActivityType']
+/** {@link Agreement} */
 export type Agreement = schemas['Agreement']
+/** {@link Commission} */
 export type Commission = schemas['Commission']
+/** {@link Count} */
 export type Count = schemas['Count']
+/** {@link Forecast} */
 export type Forecast = schemas['Forecast']
+/** {@link ForecastItem} */
 export type ForecastItem = schemas['ForecastItem']
+/** {@link Opportunity} */
 export type Opportunity = schemas['Opportunity']
+/** {@link OpportunityContact} */
 export type OpportunityContact = schemas['OpportunityContact']
+/** {@link OpportunityNote} */
 export type OpportunityNote = schemas['OpportunityNote']
+/** {@link OpportunityRating} */
 export type OpportunityRating = schemas['OpportunityRating']
+/** {@link OpportunityRatingInfo} */
 export type OpportunityRatingInfo = schemas['OpportunityRatingInfo']
+/** {@link OpportunityStage} */
 export type OpportunityStage = schemas['OpportunityStage']
+/** {@link OpportunityStageInfo} */
 export type OpportunityStageInfo = schemas['OpportunityStageInfo']
+/** {@link OpportunityStatus} */
 export type OpportunityStatus = schemas['OpportunityStatus']
+/** {@link OpportunityStatusInfo} */
 export type OpportunityStatusInfo = schemas['OpportunityStatusInfo']
+/** {@link OpportunityToAgreementConversion} */
 export type OpportunityToAgreementConversion = schemas['OpportunityToAgreementConversion']
+/** {@link OpportunityToProjectConversion} */
 export type OpportunityToProjectConversion = schemas['OpportunityToProjectConversion']
+/** {@link OpportunityToSalesOrderConversion} */
 export type OpportunityToSalesOrderConversion = schemas['OpportunityToSalesOrderConversion']
+/** {@link OpportunityToServiceTicketConversion} */
 export type OpportunityToServiceTicketConversion = schemas['OpportunityToServiceTicketConversion']
+/** {@link OpportunityType} */
 export type OpportunityType = schemas['OpportunityType']
+/** {@link OpportunityTypeInfo} */
 export type OpportunityTypeInfo = schemas['OpportunityTypeInfo']
+/** {@link Order} */
 export type Order = schemas['Order']
+/** {@link OrderStatus} */
 export type OrderStatus = schemas['OrderStatus']
+/** {@link OrderStatusEmailTemplate} */
 export type OrderStatusEmailTemplate = schemas['OrderStatusEmailTemplate']
+/** {@link OrderStatusInfo} */
 export type OrderStatusInfo = schemas['OrderStatusInfo']
+/** {@link OrderStatusNotification} */
 export type OrderStatusNotification = schemas['OrderStatusNotification']
+/** {@link PatchOperation} */
 export type PatchOperation = schemas['PatchOperation']
+/** {@link Project} */
 export type Project = schemas['Project']
+/** {@link Role} */
 export type Role = schemas['Role']
+/** {@link SalesProbability} */
 export type SalesProbability = schemas['SalesProbability']
+/** {@link SalesProbabilityInfo} */
 export type SalesProbabilityInfo = schemas['SalesProbabilityInfo']
+/** {@link SalesQuota} */
 export type SalesQuota = schemas['SalesQuota']
+/** {@link SalesTeam} */
 export type SalesTeam = schemas['SalesTeam']
+/** {@link SalesTeamMember} */
 export type SalesTeamMember = schemas['SalesTeamMember']
+/** {@link SuccessResponse} */
 export type SuccessResponse = schemas['SuccessResponse']
+/** {@link Team} */
 export type Team = schemas['Team']
+/** {@link Ticket} */
 export type Ticket = schemas['Ticket']
+/** {@link Usage} */
 export type Usage = schemas['Usage']
 
 /**
+ * @module SalesAPI
+ */
+
+/**
+ * Sales module
  * @public
  */
-export default class SalesAPI extends Manage {
+export class SalesAPI extends Manage {
   constructor(props: CWMOptions) {
     super(props)
   }

package/src/Manage/ScheduleAPI.ts

@@ -5,28 +5,50 @@ import { CommonParameters, CWMOptions } from '../ManageAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 
+/** {@link Calendar} */
 export type Calendar = schemas['Calendar']
+/** {@link CalendarInfo} */
 export type CalendarInfo = schemas['CalendarInfo']
+/** {@link Count} */
 export type Count = schemas['Count']
+/** {@link Holiday} */
 export type Holiday = schemas['Holiday']
+/** {@link HolidayList} */
 export type HolidayList = schemas['HolidayList']
+/** {@link HolidayListInfo} */
 export type HolidayListInfo = schemas['HolidayListInfo']
+/** {@link PatchOperation} */
 export type PatchOperation = schemas['PatchOperation']
+/** {@link PortalCalendar} */
 export type PortalCalendar = schemas['PortalCalendar']
+/** {@link ScheduleColor} */
 export type ScheduleColor = schemas['ScheduleColor']
+/** {@link ScheduleDetail} */
 export type ScheduleDetail = schemas['ScheduleDetail']
+/** {@link ScheduleEntry} */
 export type ScheduleEntry = schemas['ScheduleEntry']
+/** {@link ScheduleEntryDetail} */
 export type ScheduleEntryDetail = schemas['ScheduleEntryDetail']
+/** {@link ScheduleReminderTime} */
 export type ScheduleReminderTime = schemas['ScheduleReminderTime']
+/** {@link ScheduleStatus} */
 export type ScheduleStatus = schemas['ScheduleStatus']
+/** {@link ScheduleType} */
 export type ScheduleType = schemas['ScheduleType']
+/** {@link ScheduleTypeInfo} */
 export type ScheduleTypeInfo = schemas['ScheduleTypeInfo']
+/** {@link Usage} */
 export type Usage = schemas['Usage']
 
 /**
+ * @module ScheduleAPI
+ */
+
+/**
+ * Schedule module
  * @public
  */
-export default class ScheduleAPI extends Manage {
+export class ScheduleAPI extends Manage {
   constructor(props: CWMOptions) {
     super(props)
   }

package/src/Manage/ServiceAPI.ts

@@ -5,81 +5,156 @@ import { CommonParameters, CWMOptions } from '../ManageAPI'
 import { NoContentResponse, OctetStreamResponse, PDFResponse, HTMLResponse } from '../types'
 type schemas = components['schemas']
 
+/** {@link ActivityReference} */
 export type ActivityReference = schemas['ActivityReference']
+/** {@link Board} */
 export type Board = schemas['Board']
+/** {@link BoardAutoAssignResource} */
 export type BoardAutoAssignResource = schemas['BoardAutoAssignResource']
+/** {@link BoardAutoTemplate} */
 export type BoardAutoTemplate = schemas['BoardAutoTemplate']
+/** {@link BoardCopy} */
 export type BoardCopy = schemas['BoardCopy']
+/** {@link BoardExcludedMember} */
 export type BoardExcludedMember = schemas['BoardExcludedMember']
+/** {@link BoardInfo} */
 export type BoardInfo = schemas['BoardInfo']
+/** {@link BoardItem} */
 export type BoardItem = schemas['BoardItem']
+/** {@link BoardItemAssociation} */
 export type BoardItemAssociation = schemas['BoardItemAssociation']
+/** {@link BoardNotification} */
 export type BoardNotification = schemas['BoardNotification']
+/** {@link BoardStatus} */
 export type BoardStatus = schemas['BoardStatus']
+/** {@link BoardStatusInfo} */
 export type BoardStatusInfo = schemas['BoardStatusInfo']
+/** {@link BoardStatusNotification} */
 export type BoardStatusNotification = schemas['BoardStatusNotification']
+/** {@link BoardSubType} */
 export type BoardSubType = schemas['BoardSubType']
+/** {@link BoardSubTypeInfo} */
 export type BoardSubTypeInfo = schemas['BoardSubTypeInfo']
+/** {@link BoardTeam} */
 export type BoardTeam = schemas['BoardTeam']
+/** {@link BoardTeamInfo} */
 export type BoardTeamInfo = schemas['BoardTeamInfo']
+/** {@link BoardType} */
 export type BoardType = schemas['BoardType']
+/** {@link BoardTypeInfo} */
 export type BoardTypeInfo = schemas['BoardTypeInfo']
+/** {@link BoardTypeSubTypeItemAssociation} */
 export type BoardTypeSubTypeItemAssociation = schemas['BoardTypeSubTypeItemAssociation']
+/** {@link Code} */
 export type Code = schemas['Code']
+/** {@link ConfigurationReference} */
 export type ConfigurationReference = schemas['ConfigurationReference']
+/** {@link ConvertToProject} */
 export type ConvertToProject = schemas['ConvertToProject']
+/** {@link Count} */
 export type Count = schemas['Count']
+/** {@link DocumentReference} */
 export type DocumentReference = schemas['DocumentReference']
+/** {@link FilterValues} */
 export type FilterValues = schemas['FilterValues']
+/** {@link Impact} */
 export type Impact = schemas['Impact']
+/** {@link KnowledgeBaseArticle} */
 export type KnowledgeBaseArticle = schemas['KnowledgeBaseArticle']
+/** {@link KnowledgeBaseCategory} */
 export type KnowledgeBaseCategory = schemas['KnowledgeBaseCategory']
+/** {@link KnowledgeBaseSettings} */
 export type KnowledgeBaseSettings = schemas['KnowledgeBaseSettings']
+/** {@link KnowledgeBaseSubCategory} */
 export type KnowledgeBaseSubCategory = schemas['KnowledgeBaseSubCategory']
+/** {@link PatchOperation} */
 export type PatchOperation = schemas['PatchOperation']
+/** {@link Priority} */
 export type Priority = schemas['Priority']
+/** {@link PriorityInfo} */
 export type PriorityInfo = schemas['PriorityInfo']
+/** {@link ProductReference} */
 export type ProductReference = schemas['ProductReference']
+/** {@link SLA} */
 export type SLA = schemas['SLA']
+/** {@link SLAInfo} */
 export type SLAInfo = schemas['SLAInfo']
+/** {@link SLAPriority} */
 export type SLAPriority = schemas['SLAPriority']
+/** {@link ScheduleEntryReference} */
 export type ScheduleEntryReference = schemas['ScheduleEntryReference']
+/** {@link SchedulingMemberInfo} */
 export type SchedulingMemberInfo = schemas['SchedulingMemberInfo']
+/** {@link ServiceEmailTemplate} */
 export type ServiceEmailTemplate = schemas['ServiceEmailTemplate']
+/** {@link ServiceLocation} */
 export type ServiceLocation = schemas['ServiceLocation']
+/** {@link ServiceLocationInfo} */
 export type ServiceLocationInfo = schemas['ServiceLocationInfo']
+/** {@link ServiceNote} */
 export type ServiceNote = schemas['ServiceNote']
+/** {@link ServiceSignoff} */
 export type ServiceSignoff = schemas['ServiceSignoff']
+/** {@link ServiceSignoffInfo} */
 export type ServiceSignoffInfo = schemas['ServiceSignoffInfo']
+/** {@link ServiceSurvey} */
 export type ServiceSurvey = schemas['ServiceSurvey']
+/** {@link ServiceSurveyQuestion} */
 export type ServiceSurveyQuestion = schemas['ServiceSurveyQuestion']
+/** {@link ServiceTeam} */
 export type ServiceTeam = schemas['ServiceTeam']
+/** {@link ServiceTemplate} */
 export type ServiceTemplate = schemas['ServiceTemplate']
+/** {@link ServiceTemplateInfo} */
 export type ServiceTemplateInfo = schemas['ServiceTemplateInfo']
+/** {@link ServiceTicketLink} */
 export type ServiceTicketLink = schemas['ServiceTicketLink']
+/** {@link ServiceTicketLinkInfo} */
 export type ServiceTicketLinkInfo = schemas['ServiceTicketLinkInfo']
+/** {@link ServiceTicketNote} */
 export type ServiceTicketNote = schemas['ServiceTicketNote']
+/** {@link Severity} */
 export type Severity = schemas['Severity']
+/** {@link Source} */
 export type Source = schemas['Source']
+/** {@link SourceInfo} */
 export type SourceInfo = schemas['SourceInfo']
+/** {@link SuccessResponse} */
 export type SuccessResponse = schemas['SuccessResponse']
+/** {@link SurveyOption} */
 export type SurveyOption = schemas['SurveyOption']
+/** {@link SurveyResult} */
 export type SurveyResult = schemas['SurveyResult']
+/** {@link Task} */
 export type Task = schemas['Task']
+/** {@link TeamMember} */
 export type TeamMember = schemas['TeamMember']
+/** {@link TemplateGeneratedCountsModel} */
 export type TemplateGeneratedCountsModel = schemas['TemplateGeneratedCountsModel']
+/** {@link Ticket} */
 export type Ticket = schemas['Ticket']
+/** {@link TicketBundle} */
 export type TicketBundle = schemas['TicketBundle']
+/** {@link TicketInfo} */
 export type TicketInfo = schemas['TicketInfo']
+/** {@link TicketMerge} */
 export type TicketMerge = schemas['TicketMerge']
+/** {@link TicketSync} */
 export type TicketSync = schemas['TicketSync']
+/** {@link TimeEntryReference} */
 export type TimeEntryReference = schemas['TimeEntryReference']
+/** {@link Usage} */
 export type Usage = schemas['Usage']
 
 /**
+ * @module ServiceAPI
+ */
+
+/**
+ * Service module
  * @public
  */
-export default class ServiceAPI extends Manage {
+export class ServiceAPI extends Manage {
   constructor(props: CWMOptions) {
     super(props)
   }