Class EventsApi

Hierarchy

EventsApi

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new EventsApi(configuration: Configuration, requestFactory?: EventsApiRequestFactory, responseProcessor?: EventsApiResponseProcessor): EventsApi

- Defined in src/generated/types/PromiseAPI.ts:1016
Parameters
- configuration: Configuration
- Optional requestFactory: EventsApiRequestFactory
- Optional responseProcessor: EventsApiResponseProcessor
Returns EventsApi

Properties

Private api

api: ObservableEventsApi

Methods

createEvent

createEvent(createEventRequest: CreateEventRequest, _options?: Configuration): Promise<EventResponse>

- Defined in src/generated/types/PromiseAPI.ts:1029
Create a new event. Create a new event.

Parameters
- createEventRequest: CreateEventRequest
- Optional _options: Configuration
Returns Promise<EventResponse>

deleteEvent

deleteEvent(id: string, _options?: Configuration): Promise<EventDeleteResponse>

- Defined in src/generated/types/PromiseAPI.ts:1039
Delete an event. Delete an event.

Parameters
- id: string
  
  Specifies the unique event ID (starts with eve_).
- Optional _options: Configuration
Returns Promise<EventDeleteResponse>

getEvent

getEvent(id: string, _options?: Configuration): Promise<EventResponse>

- Defined in src/generated/types/PromiseAPI.ts:1049
Get a single event. Get a single event.

Parameters
- id: string
  
  Specifies the unique event ID (starts with eve_).
- Optional _options: Configuration
Returns Promise<EventResponse>

getEvents

getEvents(limit?: number, skip?: number, order?: SortOrder, name?: string, deleted?: boolean, _options?: Configuration): Promise<EventListResponse>

- Defined in src/generated/types/PromiseAPI.ts:1063
Returns a list of events. By default, a maximum of 10 events are shown per page. List events.

Parameters
- Optional limit: number
  
  Specifies the maximum number of records to return.
- Optional skip: number
  
  Specifies the offset for the first records to return.
- Optional order: SortOrder
  
  Specifies the order in which to sort the results.
- Optional name: string
  
  Specifies the name of the event
- Optional deleted: boolean
  
  Specifies if display deleted events
- Optional _options: Configuration
Returns Promise<EventListResponse>

Generated using TypeDoc