com.sinch.sdk.domains.conversation.api.v1.EventsService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sinch-sdk-java Show documentation

SDK providing a Java API for the Sinch REST APIs.

There is a newer version: 1.4.0

package com.sinch.sdk.domains.conversation.api.v1;

import com.sinch.sdk.domains.conversation.models.v1.events.ConversationEvent;
import com.sinch.sdk.domains.conversation.models.v1.events.request.EventsListRequest;
import com.sinch.sdk.domains.conversation.models.v1.events.request.SendEventRequest;
import com.sinch.sdk.domains.conversation.models.v1.events.response.EventsListResponse;
import com.sinch.sdk.domains.conversation.models.v1.events.response.SendEventResponse;

/**
 * Service for working with the Events
 *
 * @see online
 *     documentation
 * @since 1.3
 */
public interface EventsService {

  /**
   * 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
   *
   * @param request Send event request parameters
   * @return Response related to event enqueued
   * @since 1.3
   */
  SendEventResponse send(SendEventRequest request);

  /**
   * Get event from ID
   *
   * @param eventId The unique ID of the event
   * @return Conversation event
   * @since 1.3
   */
  ConversationEvent get(String eventId);

  /**
   * Delete a specific event by its ID
   *
   * @param eventId The unique ID of the event
   * @since 1.3
   */
  void delete(String eventId);

  /**
   * List all events in a project
   *
   * @param request Request parameters
   * @return List of events
   * @since 1.3
   */
  EventsListResponse list(EventsListRequest request);
}