InventoryConfiguration | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- InventoryConfiguration

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InventoryConfiguration(options: InventoryConfigurationOptions, http: Client): InventoryConfiguration

Inherited from ThBaseHandler.constructor
- Defined in src/v0/inventory_configuration.ts:71
Parameters
- options: InventoryConfigurationOptions
- http: Client
Returns InventoryConfiguration

Properties

Optional active

active: null | boolean

Optional autoGenerate

autoGenerate: null | boolean

endpoint

endpoint: string

http

http: Client

Optional id

id: string

options

options: InventoryConfigurationOptions

Optional owner

owner: null | string

Optional template

template: null | string

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/inventory-configurations'

Methods

get

get(configurationId: string): Promise<InventoryConfigurationReference>

- Defined in src/v0/inventory_configuration.ts:103
Parameters
- configurationId: string
Returns Promise<InventoryConfigurationReference>

getAll

getAll(optionsOrQuery?: InventoryConfigurationsQueryOptions): Promise<InventoryConfigurationsResponse>

- Defined in src/v0/inventory_configuration.ts:86
Parameters
- Optional optionsOrQuery: InventoryConfigurationsQueryOptions
Returns Promise<InventoryConfigurationsResponse>

put

put(configurationId: string, configuration: InventoryConfiguration): Promise<InventoryConfigurationResponse>

- Defined in src/v0/inventory_configuration.ts:125
Parameters
- configurationId: string
- configuration: InventoryConfiguration
Returns Promise<InventoryConfigurationResponse>

Generated using TypeDoc