Class EventsService

Hierarchy

EventsService

Index

Constructors

constructor

Methods

get
getAll

Constructors

constructor

new EventsService(): EventsService

- Defined in lib/services/events-service.ts:4
Returns EventsService

Methods

get

get(eventId: string): Promise<EventObject>

- Defined in lib/services/events-service.ts:31
Download a specific event for a xs2a transaction object

Parameters
- eventId: string
  
  id of event to retrieve
Returns Promise<EventObject>

getAll

getAll(parameters?: EventsQueryParameters): Promise<EventsList>

- Defined in lib/services/events-service.ts:13
An event is basically the API representation of a webhook. Every webhook you receive fires an event, that you can process further.

summary

Get all events for a xs2a transaction object

Parameters
- Default value parameters: EventsQueryParameters = {}
Returns Promise<EventsList>

Generated using TypeDoc