Interface EventsService


public interface EventsService
Events Service
  • Method Details

    • list

      List events (using default parameters)

      List all events in a project

      Returns:
      EventsListResponse
      Throws:
      ApiException - if fails to make API call
    • list

      List events

      List all events in a project

      Parameters:
      queryParameter - (optional)
      Returns:
      EventsListResponse
      Throws:
      ApiException - if fails to make API call
    • delete

      void delete(String eventId) throws ApiException
      Delete an event

      Delete a specific event by its ID.

      Parameters:
      eventId - The unique ID of the event. (required)
      Throws:
      ApiException - if fails to make API call
    • get

      ConversationEvent get(String eventId) throws ApiException
      Get an event

      Get event from ID

      Parameters:
      eventId - The unique ID of the event. (required)
      Returns:
      ConversationEvent
      Throws:
      ApiException - if fails to make API call
    • send

      SendEventResponse send(SendEventRequest sendEventRequest) throws ApiException
      Send an event

      Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.

      Parameters:
      sendEventRequest - The event to be sent. (required)
      Returns:
      SendEventResponse
      Throws:
      ApiException - if fails to make API call