Registers | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Registers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Registers(options: RegistersOptions, http: Client): Registers

Overrides ThBaseHandler.constructor
- Defined in src/v1/registers.ts:73
Parameters
- options: RegistersOptions
- http: Client
Returns Registers

Properties

endpoint

endpoint: string

http

http: Client

options

options: RegistersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

get

get(registerId: string): Promise<RegisterResponse>

- Defined in src/v1/registers.ts:111
Parameters
- registerId: string
Returns Promise<RegisterResponse>

getAll

getAll(q?: RegistersQuery): Promise<RegistersResponse>

- Defined in src/v1/registers.ts:88
Parameters
- Optional q: RegistersQuery
Returns Promise<RegistersResponse>

notify

notify(registerId: string, notification: Notification): Promise<NotificationResponse>

- Defined in src/v1/registers.ts:124
Parameters
- registerId: string
- notification: Notification
Returns Promise<NotificationResponse>

put

put(registerId: string, register: Register): Promise<RegisterResponse>

- Defined in src/v1/registers.ts:154
Parameters
- registerId: string
- register: Register
Returns Promise<RegisterResponse>

search

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

- Defined in src/v1/registers.ts:168
Parameters
- query: string | SearchQuery
Returns Promise<RegisterResponse>

updateDeviceConfiguration

updateDeviceConfiguration(registerId: string, deviceConfiguration: DeviceConfigurationObject): Promise<RegisterResponse>

- Defined in src/v1/registers.ts:137
Parameters
- registerId: string
- deviceConfiguration: DeviceConfigurationObject
Returns Promise<RegisterResponse>

Generated using TypeDoc