Class HostResource

host_cmds hook: host reservation management.

Index

Constructors

Methods

delReservation getAllReservations getReservation getReservationByHostname getReservationById getReservationPage setReservation updateReservation

Constructors

constructor

new HostResource(request: Requester): HostResource
Parameters
- request: Requester
Returns HostResource
- Defined in src/client.ts:340

Methods

delReservation

delReservation(args: ReservationDelArgs, service?: string[]): Promise<void>
Parameters
- args: ReservationDelArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:370

getAllReservations

getAllReservations(
args?: ReservationGetAllArgs,
service?: string[],
): Promise<ReservationGetResult>
Parameters
- Optionalargs: ReservationGetAllArgs
- Optionalservice: string[]
Returns Promise<ReservationGetResult>
- Defined in src/client.ts:350

getReservation

getReservation(
args: ReservationGetArgs,
service?: string[],
): Promise<ReservationGetResult>
Parameters
- args: ReservationGetArgs
- Optionalservice: string[]
Returns Promise<ReservationGetResult>
- Defined in src/client.ts:346

getReservationByHostname

getReservationByHostname(
args: ReservationGetByHostnameArgs,
service?: string[],
): Promise<ReservationGetResult>
Parameters
- args: ReservationGetByHostnameArgs
- Optionalservice: string[]
Returns Promise<ReservationGetResult>
- Defined in src/client.ts:358

getReservationById

getReservationById(
args: ReservationGetByIdArgs,
service?: string[],
): Promise<ReservationGetResult>
Parameters
- args: ReservationGetByIdArgs
- Optionalservice: string[]
Returns Promise<ReservationGetResult>
- Defined in src/client.ts:366

getReservationPage

getReservationPage(
args: ReservationGetPageArgs,
service?: string[],
): Promise<ReservationGetResult>
Parameters
- args: ReservationGetPageArgs
- Optionalservice: string[]
Returns Promise<ReservationGetResult>
- Defined in src/client.ts:354

setReservation

setReservation(args: ReservationAddArgs, service?: string[]): Promise<void>
Parameters
- args: ReservationAddArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:342

updateReservation

updateReservation(
args: ReservationUpdateArgs,
service?: string[],
): Promise<void>
Parameters
- args: ReservationUpdateArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:374