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/v0/branches.ts:75
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/v0/branches'

Methods

count

count(): Promise<BranchesResponse>

- Defined in src/v0/branches.ts:160
Returns Promise<BranchesResponse>

create

create(branch: Branch): Promise<BranchResponse>

- Defined in src/v0/branches.ts:146
Parameters
- branch: Branch
Returns Promise<BranchResponse>

delete

delete(branchId: string): Promise<BranchResponse>

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

get

get(branchId: string): Promise<BranchResponse>

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

getAll

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

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

getUniqueExternalId

getUniqueExternalId(query: ExternalCustomIdQuery): Promise<BranchResponse>

- Defined in src/v0/branches.ts:192
Parameters
- query: ExternalCustomIdQuery
Returns Promise<BranchResponse>

put

put(branchId: string, branch: Branch): Promise<BranchResponse>

- Defined in src/v0/branches.ts:132
Parameters
- branchId: string
- branch: Branch
Returns Promise<BranchResponse>

search

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

- Defined in src/v0/branches.ts:219
Parameters
- query: string | SearchQuery
Returns Promise<BranchResponse>

Generated using TypeDoc