Warehouses | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Warehouses

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Warehouses(options: WarehousesOptions, http: Client): Warehouses

Overrides ThBaseHandler.constructor
- Defined in src/v0/warehouses.ts:84
Parameters
- options: WarehousesOptions
- http: Client
Returns Warehouses

Properties

endpoint

endpoint: string

http

http: Client

options

options: WarehousesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(warehouse: Warehouse): Promise<WarehousesResponse>

- Defined in src/v0/warehouses.ts:136
Parameters
- warehouse: Warehouse
Returns Promise<WarehousesResponse>

delete

delete(warehouseId: string): Promise<WarehousesResponse>

- Defined in src/v0/warehouses.ts:174
Parameters
- warehouseId: string
Returns Promise<WarehousesResponse>

getAll

getAll(query?: WarehousesQuery): Promise<WarehousesResponse>

- Defined in src/v0/warehouses.ts:99
Parameters
- Optional query: WarehousesQuery
Returns Promise<WarehousesResponse>

getOne

getOne(warehouseId: string): Promise<WarehousesResponse>

- Defined in src/v0/warehouses.ts:118
Parameters
- warehouseId: string
Returns Promise<WarehousesResponse>

put

put(warehouseId: string, warehouse: Warehouse): Promise<WarehousesResponse>

- Defined in src/v0/warehouses.ts:155
Parameters
- warehouseId: string
- warehouse: Warehouse
Returns Promise<WarehousesResponse>

Generated using TypeDoc