Function EventsApiFactory

  • EventsApi - factory interface

    Export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        getEvent(requestParameters, options?) => AxiosPromise<Event>;
        listEvents(requestParameters, options?) => AxiosPromise<ListEvents200Response>;
    }

    • getEvent:function
      • getEvent(requestParameters, options?): AxiosPromise<Event>

      • Retrieves the details of an Event.

        Summary

        Get an Event

        Throws

        Parameters

        • requestParameters: EventsApiGetEventRequest

          Request parameters.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<Event>

    • listEvents:function
      • listEvents(requestParameters, options?): AxiosPromise<ListEvents200Response>

      • 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

        Parameters

        • requestParameters: EventsApiListEventsRequest

          Request parameters.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<ListEvents200Response>

Settings

Member Visibility

Theme

Generated using TypeDoc