Stocks | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Stocks

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Stocks(options: StocksOptions, http: Client): Stocks

Overrides ThBaseHandler.constructor
- Defined in src/v0/stocks.ts:79
Parameters
- options: StocksOptions
- http: Client
Returns Stocks

Properties

endpoint

endpoint: string

http

http: Client

options

options: StocksOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(stock: Stock): Promise<StocksResponse>

- Defined in src/v0/stocks.ts:108
Parameters
- stock: Stock
Returns Promise<StocksResponse>

getAll

getAll(query?: StocksQuery): Promise<StocksResponse>

- Defined in src/v0/stocks.ts:91
Parameters
- Optional query: StocksQuery
Returns Promise<StocksResponse>

getLocations

getLocations(query?: StocksQuery): Promise<StocksResponse>

- Defined in src/v0/stocks.ts:141
Parameters
- Optional query: StocksQuery
Returns Promise<StocksResponse>

getOneLocation

getOneLocation(locationId: string): Promise<StocksResponse>

- Defined in src/v0/stocks.ts:158
Parameters
- locationId: string
Returns Promise<StocksResponse>

transfer

transfer(body: TransferRequestObject): Promise<StocksResponse>

- Defined in src/v0/stocks.ts:174
Parameters
- body: TransferRequestObject
Returns Promise<StocksResponse>

update

update(requestObject: StocksUpdateRequestObject): Promise<StocksResponse>

- Defined in src/v0/stocks.ts:124
Parameters
- requestObject: StocksUpdateRequestObject
Returns Promise<StocksResponse>

Generated using TypeDoc