Messages | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Messages

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Messages(options: MessagesOptions, http: Client): Messages

Overrides ThBaseHandler.constructor
- Defined in src/v0/messages.ts:49
Parameters
- options: MessagesOptions
- http: Client
Returns Messages

Properties

endpoint

endpoint: string

http

http: Client

options

options: MessagesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

getAll

getAll(query?: MessagesQueryOptions): Promise<MessagesResponse>

- Defined in src/v0/messages.ts:64
Parameters
- Optional query: MessagesQueryOptions
Returns Promise<MessagesResponse>

update

update(messageId: string, messageRequest: Message): Promise<MessageResponse>

- Defined in src/v0/messages.ts:81
Parameters
- messageId: string
- messageRequest: Message
Returns Promise<MessageResponse>

Generated using TypeDoc