Staff | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Staff

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Staff(options: StaffOptions, http: Client): Staff

Overrides ThBaseHandler.constructor
- Defined in src/v0/staff.ts:143
Parameters
- options: StaffOptions
- http: Client
Returns Staff

Properties

endpoint

endpoint: string

http

http: Client

options

options: StaffOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/staff'

Methods

create

create(staffMember: StaffMember, query?: HandleStaffQuery): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:181
Parameters
- staffMember: StaffMember
- Optional query: HandleStaffQuery
Returns Promise<StaffMemberResponse>

delete

delete(staffId: string): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:254
Parameters
- staffId: string
Returns Promise<StaffMemberResponse>

get

get(staffId: string): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:219
Parameters
- staffId: string
Returns Promise<StaffMemberResponse>

getAll

getAll(queryOrOptions?: StaffQueryOrOptions): Promise<StaffResponse>

- Defined in src/v0/staff.ts:155
Parameters
- Optional queryOrOptions: StaffQueryOrOptions
Returns Promise<StaffResponse>

getFilters

getFilters(queryOrOptions?: StaffQueryOrOptions): Promise<StaffResponse>

- Defined in src/v0/staff.ts:322
Parameters
- Optional queryOrOptions: StaffQueryOrOptions
Returns Promise<StaffResponse>

getOne

getOne(staffId: string): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:199
Parameters
- staffId: string
Returns Promise<StaffMemberResponse>

getPin

getPin(providedPin?: PinRequest): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:268
Parameters
- Optional providedPin: PinRequest
Returns Promise<StaffMemberResponse>

getServices

getServices(staffId: string): Promise<StaffServicesResponse>

- Defined in src/v0/staff.ts:366
Parameters
- staffId: string
Returns Promise<StaffServicesResponse>

getStaffNumber

getStaffNumber(providedStaffNumber?: StaffNumberRequest): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:295
Parameters
- Optional providedStaffNumber: StaffNumberRequest
Returns Promise<StaffMemberResponse>

makeUser

makeUser(staffID: string, makeUserObj: MakeUserRequest): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:386
Parameters
- staffID: string
- makeUserObj: MakeUserRequest
Returns Promise<StaffMemberResponse>

meta

meta(query?: StaffQueryOrOptions): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:402
Parameters
- Optional query: StaffQueryOrOptions
Returns Promise<StaffMemberResponse>

put

put(staffId: string, staff: StaffMember): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:237
Parameters
- staffId: string
- staff: StaffMember
Returns Promise<StaffMemberResponse>

search

search(query: string | SearchQuery): Promise<StaffMemberResponse>

- Defined in src/v0/staff.ts:424
Parameters
- query: string | SearchQuery
Returns Promise<StaffMemberResponse>

Generated using TypeDoc