Class EventsApi

EventsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- EventsApi

Index

Constructors

Properties

axios basePath configuration

Methods

getEvent listEvents

Constructors

constructor

new EventsApi(configuration?, basePath?, axios?): EventsApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns EventsApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

getEvent

getEvent(requestParameters, options?): Promise<AxiosResponse<Event, any>>
Retrieves the details of an Event.

Summary
Get an Event

Throws

Memberof
EventsApi
Parameters
- requestParameters: EventsApiGetEventRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<Event, any>>
- Defined in api/events-api.ts:328

listEvents

listEvents(requestParameters, options?): Promise<AxiosResponse<ListEvents200Response, any>>
Returns a list of Events from the past 30 days. The Events are sorted with the most recently created appearing first.

Summary
List all Events

Throws

Memberof
EventsApi
Parameters
- requestParameters: EventsApiListEventsRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ListEvents200Response, any>>
- Defined in api/events-api.ts:340

Generated using TypeDoc