StaffGroups | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- StaffGroups

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StaffGroups(options: StaffGroupsOptions, http: Client): StaffGroups

Overrides ThBaseHandler.constructor
- Defined in src/v0/staff_groups.ts:51
Parameters
- options: StaffGroupsOptions
- http: Client
Returns StaffGroups

Properties

endpoint

endpoint: string

http

http: Client

options

options: StaffGroupsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(staffGroup: StaffGroup): Promise<StaffGroupResponse>

- Defined in src/v0/staff_groups.ts:137
Parameters
- staffGroup: StaffGroup
Returns Promise<StaffGroupResponse>

delete

delete(staffGroupId: string): Promise<StaffGroupResponse>

- Defined in src/v0/staff_groups.ts:151
Parameters
- staffGroupId: string
Returns Promise<StaffGroupResponse>

get

get(staffGroupId: string): Promise<StaffGroupResponse>

- Defined in src/v0/staff_groups.ts:105
Parameters
- staffGroupId: string
Returns Promise<StaffGroupResponse>

getAll

getAll(query?: StaffGroupsQuery): Promise<StaffGroupsResponse>

- Defined in src/v0/staff_groups.ts:66
Parameters
- Optional query: StaffGroupsQuery
Returns Promise<StaffGroupsResponse>

meta

meta(): Promise<StaffGroupsResponse>

- Defined in src/v0/staff_groups.ts:89
Returns Promise<StaffGroupsResponse>

put

put(staffGroupId: string, staffGroup: StaffGroup): Promise<StaffGroupResponse>

- Defined in src/v0/staff_groups.ts:123
Parameters
- staffGroupId: string
- staffGroup: StaffGroup
Returns Promise<StaffGroupResponse>

Generated using TypeDoc