Branches | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Branches

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Branches(options: BranchesOptions, http: Client): Branches

Overrides ThBaseHandler.constructor
- Defined in src/v1/branches.ts:88
Parameters
- options: BranchesOptions
- http: Client
Returns Branches

Properties

endpoint

endpoint: string

http

http: Client

options

options: BranchesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v1/branches'

Methods

get

get(branchId: string): Promise<BranchResponse>

- Defined in src/v1/branches.ts:146
Parameters
- branchId: string
Returns Promise<BranchResponse>

getAll

getAll(queryOrOptions?: BranchesQuery): Promise<BranchesResponse>

- Defined in src/v1/branches.ts:103
Parameters
- Optional queryOrOptions: BranchesQuery
Returns Promise<BranchesResponse>

meta

meta(queryOrOptions?: BranchesQuery): Promise<BranchesResponse>

- Defined in src/v1/branches.ts:129
Parameters
- Optional queryOrOptions: BranchesQuery
Returns Promise<BranchesResponse>

Generated using TypeDoc