Class HardwareManager

Hierarchy

Manager
- HardwareManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HardwareManager(snipeURL: string, apiToken: string): HardwareManager

Inherited from Manager.constructor
- Defined in src/lib/Manager.ts:4
Parameters
- snipeURL: string
- apiToken: string
Returns HardwareManager

Properties

apiToken

apiToken: string

snipeURL

snipeURL: string

Methods

audit

audit(asset_tag: string, location_id?: undefined | number): Promise<Hardware>

- Defined in src/lib/Hardware/HardwareManager.ts:243
Mark an asset as audited.

Parameters
- asset_tag: string
  
  Asset tag of asset to audit.
- Optional location_id: undefined | number
  
  ID of location.
Returns Promise<Hardware>

checkin

checkin(id: number, note?: undefined | string, location_id?: undefined | number): Promise<Hardware>

- Defined in src/lib/Hardware/HardwareManager.ts:100
Checkin a asset.

Parameters
- id: number
  
  Asset ID.
- Optional note: undefined | string
  
  Note.
- Optional location_id: undefined | number
  
  Location ID.
Returns Promise<Hardware>

checkout

checkout(id: number, options: CheckoutOptions): Promise<Hardware>

- Defined in src/lib/Hardware/HardwareManager.ts:123
Checkout a asset.

Parameters
- id: number
  
  Asset ID to checkin.
- options: CheckoutOptions
  
  Options to pass to the API.
Returns Promise<Hardware>

delete

delete(id: number): Promise<void>

- Defined in src/lib/Hardware/HardwareManager.ts:179
Delete specific asset by ID.

Parameters
- id: number
  
  Asset ID.
Returns Promise<void>

get

get(options?: HardwareOptions): Promise<Hardware[]>

- Defined in src/lib/Hardware/HardwareManager.ts:21
Return list of assets.

Parameters
- Optional options: HardwareOptions
  
  Options - Options to pass to the API.
Returns Promise<Hardware[]>

getAssetTag

getAssetTag(asset_tag: string): Promise<Hardware>

- Defined in src/lib/Hardware/HardwareManager.ts:60
Get specific asset by Asset Tag.

Parameters
- asset_tag: string
  
  Asset tag.
Returns Promise<Hardware>

getAuditDue

getAuditDue(): Promise<Hardware[]>

- Defined in src/lib/Hardware/HardwareManager.ts:140
Return a list of assets that are due for audit soon.

Returns Promise<Hardware[]>

getID

getID(id: number): Promise<Hardware>

- Defined in src/lib/Hardware/HardwareManager.ts:41
Get specific asset by Asset ID.

Parameters
- id: number
  
  Asset ID.
Returns Promise<Hardware>

getOverdueAudit

getOverdueAudit(): Promise<Hardware[]>

- Defined in src/lib/Hardware/HardwareManager.ts:158
Return a list of assets that are overdue for audit.

Returns Promise<Hardware[]>

getSerial

getSerial(serial: string): Promise<Hardware[]>

- Defined in src/lib/Hardware/HardwareManager.ts:79
Get specific asset by Serial.

Parameters
- serial: string
  
  Asset tag.
Returns Promise<Hardware[]>

new

new(options: HardwarePostOptions): Promise<Hardware>

- Defined in src/lib/Hardware/HardwareManager.ts:196
Make new asset.

Parameters
- options: HardwarePostOptions
Returns Promise<Hardware>

update

update(id: number, options: HardwareUpdateOptions): Promise<Hardware>

- Defined in src/lib/Hardware/HardwareManager.ts:220
Update an asset.

Parameters
- id: number
- options: HardwareUpdateOptions
  
  Options to pass to the API.
Returns Promise<Hardware>

Generated using TypeDoc