com.ngrok.services.EventSubscriptions.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ngrok-api-scala_2.13 Show documentation
ngrok API client for Scala applications
There is a newer version: 0.7.0
package com.ngrok.services

import com.ngrok.NgrokApiClient
import com.ngrok.definitions._
import io.circe.Encoder
import io.circe.syntax._
import scala.concurrent.{ExecutionContext, Future}

object EventSubscriptions {
  private case class EventSubscriptionsCreate(
    metadata: Option[String],
    description: Option[String],
    sources: Option[List[EventSourceReplace]],
    destinationIds: Option[List[String]]
  )

  private object EventSubscriptionsCreate {
    implicit val encodeEventSubscriptionsCreate: Encoder[EventSubscriptionsCreate] =
      Encoder.encodeJsonObject.contramap(value =>
        List(
          value.metadata.map(_.asJson).map(("metadata", _)),
          value.description.map(_.asJson).map(("description", _)),
          value.sources.map(_.asJson).map(("sources", _)),
          value.destinationIds.map(_.asJson).map(("destination_ids", _))
        ).flatten.toMap.asJsonObject
      )
  }

  private case class EventSubscriptionsUpdate(
    metadata: Option[String],
    description: Option[String],
    sources: Option[List[EventSourceReplace]],
    destinationIds: Option[List[String]]
  )

  private object EventSubscriptionsUpdate {
    implicit val encodeEventSubscriptionsUpdate: Encoder[EventSubscriptionsUpdate] =
      Encoder.encodeJsonObject.contramap(value =>
        List(
          value.metadata.map(_.asJson).map(("metadata", _)),
          value.description.map(_.asJson).map(("description", _)),
          value.sources.map(_.asJson).map(("sources", _)),
          value.destinationIds.map(_.asJson).map(("destination_ids", _))
        ).flatten.toMap.asJsonObject
      )
  }

}

/** An API client for [[EventSubscriptions]].
  *
  * See also https://ngrok.com/docs/api#api-event-subscriptions.
  */
class EventSubscriptions private[ngrok] (apiClient: NgrokApiClient)(implicit ec: ExecutionContext) {
  import EventSubscriptions._

  /** Create an Event Subscription.
    *
    * See also https://ngrok.com/docs/api#api-event-subscriptions-create.
    *
    * @param metadata Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    * @param description Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    * @param sources Sources containing the types for which this event subscription will trigger
    * @param destinationIds A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
    * @return a [[scala.concurrent.Future]] encapsulating the API call's result
    */
  def create(
    metadata: Option[String] = None,
    description: Option[String] = None,
    sources: Option[List[EventSourceReplace]] = None,
    destinationIds: Option[List[String]] = None
  ): Future[EventSubscription] =
    apiClient.sendRequest[EventSubscription](
      NgrokApiClient.HttpMethod.Post,
      "/event_subscriptions",
      List.empty,
      Option(
        EventSubscriptionsCreate(
          metadata,
          description,
          sources,
          destinationIds
        ).asJson
      )
    )

  /** Delete an Event Subscription.
    *
    * See also https://ngrok.com/docs/api#api-event-subscriptions-delete.
    *
    * @param id a resource identifier
    * @return a [[scala.concurrent.Future]] encapsulating the API call's result
    */
  def delete(
    id: String
  ): Future[Unit] =
    apiClient.sendRequest[Unit](
      NgrokApiClient.HttpMethod.Delete,
      s"/event_subscriptions/$id",
      List.empty,
      Option.empty
    )

  /** Get an Event Subscription by ID.
    *
    * See also https://ngrok.com/docs/api#api-event-subscriptions-get.
    *
    * @param id a resource identifier
    * @return a [[scala.concurrent.Future]] encapsulating the API call's result
    */
  def get(
    id: String
  ): Future[EventSubscription] =
    apiClient.sendRequest[EventSubscription](
      NgrokApiClient.HttpMethod.Get,
      s"/event_subscriptions/$id",
      List.empty,
      Option.empty
    )

  /** List this Account's Event Subscriptions.
    *
    * See also https://ngrok.com/docs/api#api-event-subscriptions-list.
    *
    * @param beforeId the value of the before_id parameter as a [[scala.Predef.String]]
    * @param limit the value of the limit parameter as a [[scala.Predef.String]]
    * @return a [[scala.concurrent.Future]] encapsulating the API call's result
    */
  def list(
    beforeId: Option[String] = None,
    limit: Option[String] = None
  ): Future[Page[EventSubscriptionList]] =
    apiClient
      .sendRequest[EventSubscriptionList](
        NgrokApiClient.HttpMethod.Get,
        "/event_subscriptions",
        List(
          ("before_id", beforeId),
          ("limit", limit)
        ),
        Option.empty
      )
      .map(new Page(apiClient, _))

  /** Update an Event Subscription.
    *
    * See also https://ngrok.com/docs/api#api-event-subscriptions-update.
    *
    * @param id Unique identifier for this Event Subscription.
    * @param metadata Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    * @param description Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    * @param sources Sources containing the types for which this event subscription will trigger
    * @param destinationIds A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
    * @return a [[scala.concurrent.Future]] encapsulating the API call's result
    */
  def update(
    id: String,
    metadata: Option[String] = None,
    description: Option[String] = None,
    sources: Option[List[EventSourceReplace]] = None,
    destinationIds: Option[List[String]] = None
  ): Future[EventSubscription] =
    apiClient.sendRequest[EventSubscription](
      NgrokApiClient.HttpMethod.Patch,
      s"/event_subscriptions/$id",
      List.empty,
      Option(
        EventSubscriptionsUpdate(
          metadata,
          description,
          sources,
          destinationIds
        ).asJson
      )
    )

}