Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

AVTemplatePoliciesAPI

AVTemplatePoliciesAPI: AVTemplatePoliciesAPI

ClientsAPI

ClientsAPI: ClientsAPI

CommandsAPI

CommandsAPI: CommandsAPI

ComputersAPI

ComputersAPI: ComputersAPI

ContactsAPI

ContactsAPI: ContactsAPI

DataViewsAPI

DataViewsAPI: DataViewsAPI

DrivesAPI

DrivesAPI: DrivesAPI

EventLogsAPI

EventLogsAPI: EventLogsAPI

LocationsAPI

LocationsAPI: LocationsAPI

MaintenanceWindowDefinitionsAPI

MaintenanceWindowDefinitionsAPI: MaintenanceWindowDefinitionsAPI

MonitorsAPI

MonitorsAPI: MonitorsAPI

NetworkDevicesAPI

NetworkDevicesAPI: NetworkDevicesAPI

PatchingAPI

PatchingAPI: PatchingAPI

RemoteAgentAPI

RemoteAgentAPI: RemoteAgentAPI

ScriptingAPI

ScriptingAPI: ScriptingAPI

SearchesAPI

SearchesAPI: SearchesAPI

SystemAPI

SystemAPI: types.AutomateApis.SystemAPITypes.SystemAPI

TicketsAPI

TicketsAPI: TicketsAPI

UserProfilesAPI

UserProfilesAPI: UserProfilesAPI

config

config: AutomateConfig

paginate

paginate: (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>

Type declaration

    • (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]): Promise<unknown[]>
    • example
       cwa.paginate(cwa.ComputersAPI.getComputerList, {startPage: 1, pageSize: 1000}, {conditions: 'inactiveFlag = false'})

      Parameters

      • apiMethod: Function
      • paginateArgs: PaginationOptions
      • Rest ...methodArgs: Record<string, unknown>[]

      Returns Promise<unknown[]>

request

request: (args: RequestOptions) => Promise<any>

Type declaration

Accessors

token

  • get token(): undefined | string
  • set token(token: undefined | string): void

  • Returns undefined | string

  • Parameters

    • token: undefined | string

    Returns void

Methods

verifyToken

  • verifyToken(): Promise<boolean>

Static getToken

  • getToken(__namedParameters: { password?: string; serverUrl: string; twoFactorPasscode?: string; username?: string }): Promise<{ AbsoluteExpirationDate?: string; AccessToken?: string; ExpirationDate?: string; IsInternalTwoFactorRequired?: boolean; IsTwoFactorRequired?: boolean; TokenType?: string; UserId?: string }>

  • Parameters

    • __namedParameters: { password?: string; serverUrl: string; twoFactorPasscode?: string; username?: string }
      • Optional password?: string
      • serverUrl: string
      • Optional twoFactorPasscode?: string
      • Optional username?: string

    Returns Promise<{ AbsoluteExpirationDate?: string; AccessToken?: string; ExpirationDate?: string; IsInternalTwoFactorRequired?: boolean; IsTwoFactorRequired?: boolean; TokenType?: string; UserId?: string }>

Generated using TypeDoc