BranchGroups | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- BranchGroups

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BranchGroups(options: BranchGroupsOptions, http: Client): BranchGroups

Overrides ThBaseHandler.constructor
- Defined in src/v0/branch_groups.ts:55
Parameters
- options: BranchGroupsOptions
- http: Client
Returns BranchGroups

Properties

endpoint

endpoint: string

http

http: Client

options

options: BranchGroupsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(branchGroup: BranchGroup): Promise<BranchGroupResponse>

- Defined in src/v0/branch_groups.ts:130
Parameters
- branchGroup: BranchGroup
Returns Promise<BranchGroupResponse>

delete

delete(branchId: string): Promise<BranchGroupResponse>

- Defined in src/v0/branch_groups.ts:144
Parameters
- branchId: string
Returns Promise<BranchGroupResponse>

get

get(branchId: string): Promise<BranchGroupResponse>

- Defined in src/v0/branch_groups.ts:97
Parameters
- branchId: string
Returns Promise<BranchGroupResponse>

getAll

getAll(queryOrOptions?: BranchGroupsQuery): Promise<BranchGroupsResponse>

- Defined in src/v0/branch_groups.ts:70
Parameters
- Optional queryOrOptions: BranchGroupsQuery
Returns Promise<BranchGroupsResponse>

put

put(branchId: string, branchGroup: BranchGroup): Promise<BranchGroupResponse>

- Defined in src/v0/branch_groups.ts:116
Parameters
- branchId: string
- branchGroup: BranchGroup
Returns Promise<BranchGroupResponse>

Generated using TypeDoc