Class EventsApiWrapper

Hierarchy

BaseApiWrapper<EventsApi>
- EventsApiWrapper

Index

Constructors

constructor

Properties

Accessors

observers

Methods

Constructors

constructor

new EventsApiWrapper(accessToken: string, basePath?: string): EventsApiWrapper

Overrides BaseApiWrapper.constructor
- Defined in src/apis/eventsApiWrapper.ts:17
Parameters
- accessToken: string
- Optional basePath: string
Returns EventsApiWrapper

Properties

Protected Readonly api

Static type

type: string = "events"

Accessors

observers

get observers(): Observer[]

Inherited from BaseApiWrapper.observers
- Defined in src/apis/baseApiWrapper.ts:36
Returns Observer[]

Methods

create

create(req: CreateEventRequest): Promise<EventResponse>

- Defined in src/apis/eventsApiWrapper.ts:25
Create a event.

Parameters
- req: CreateEventRequest
  
  Parameters to create a event.
Returns Promise<EventResponse>

delete

delete(id: string): Promise<EventDeleteResponse>

- Defined in src/apis/eventsApiWrapper.ts:51
Delete a event by providing its event id.

Parameters
- id: string
  
  Id of the event
Returns Promise<EventDeleteResponse>

get

get(req: GetEventRequest): Promise<EventResponse>

- Defined in src/apis/eventsApiWrapper.ts:43
Retrieves the details of an existing event. Supply the unique event ID.

Supply the unique event ID.

Parameters
- req: GetEventRequest
  
  Criteria to get event by.
Returns Promise<EventResponse>

list

list(req: EventListQueries): Promise<EventListResponse>

- Defined in src/apis/eventsApiWrapper.ts:33
Returns a list of events. The events are returned sorted by creation date, with the most recently created appearing first. By default, a maximum of 10 events are shown per page.

Parameters
- req: EventListQueries
  
  Criteria to get events by.
Returns Promise<EventListResponse>

subscribe

subscribe(observer: Observer): void

Inherited from BaseApiWrapper.subscribe
- Defined in src/apis/baseApiWrapper.ts:32
Parameters
- observer: Observer
Returns void

Generated using TypeDoc