Class StatusLabelManager

Hierarchy

Manager
- StatusLabelManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

apiToken

apiToken: string

snipeURL

snipeURL: string

Methods

delete

delete(id: number): Promise<void>

- Defined in src/lib/StatusLabels/StatusLabelManager.ts:111
Delete a status label.

Parameters
- id: number
  
  ID of status label to delete.
Returns Promise<void>

get

get(options: StatusLabelGetOptions): Promise<StatusLabel[]>

- Defined in src/lib/StatusLabels/StatusLabelManager.ts:20
Get status labels.

Parameters
- options: StatusLabelGetOptions
  
  Options to pass to the API.
Returns Promise<StatusLabel[]>

getAssets

getAssets(id: number): Promise<Hardware[]>

- Defined in src/lib/StatusLabels/StatusLabelManager.ts:126
View assets with a specific status label.

Parameters
- id: number
  
  ID of status label to fetch.
Returns Promise<Hardware[]>

getID

getID(id: number): Promise<StatusLabel>

- Defined in src/lib/StatusLabels/StatusLabelManager.ts:41
Fetch specific status label.

Parameters
- id: number
  
  ID of status label to fetch.
Returns Promise<StatusLabel>

new

new(name: string, type?: "deloyable" | "pending" | "archived"): Promise<StatusLabel>

- Defined in src/lib/StatusLabels/StatusLabelManager.ts:61
Make new statuslabel.

Parameters
- name: string
  
  Name of status label.
- Optional type: "deloyable" | "pending" | "archived"
  
  Type of status label: deployable, pending or archived.
Returns Promise<StatusLabel>

update

update(id: number, options: StatusLabelOptions): Promise<StatusLabel>

- Defined in src/lib/StatusLabels/StatusLabelManager.ts:84
Edit a status label.

Parameters
- id: number
  
  ID of status label to update.
- options: StatusLabelOptions
  
  Options to pass to the API.
Returns Promise<StatusLabel>

Generated using TypeDoc