/** * Generated by API Builder - https://www.apibuilder.io * Service version: 0.0.1 * User agent: apibuilder app.apibuilder.io/nccloud/reporting-api/0.0.1/play_2_6_client */ package de.nccloud.reporting.api.v0.models { sealed trait ReportingEvent extends _root_.scala.Product with _root_.scala.Serializable { def reportingEventType: ReportingEventType } /** * Defines the valid type values for the type ReportingEvent */ sealed trait ReportingEventType extends _root_.scala.Product with _root_.scala.Serializable object ReportingEventType { case object UpdateEvent extends ReportingEventType { override def toString = "update_event" } case object DeleteEvent extends ReportingEventType { override def toString = "delete_event" } final case class UNDEFINED(override val toString: String) extends ReportingEventType val all: scala.List[ReportingEventType] = scala.List(UpdateEvent, DeleteEvent) private val byName: Map[String, ReportingEventType] = all.map(x => x.toString.toLowerCase -> x).toMap def apply(value: String): ReportingEventType = fromString(value).getOrElse(UNDEFINED(value)) def fromString(value: String): _root_.scala.Option[ReportingEventType] = byName.get(value.toLowerCase) } /** * Deletes a reporting entity defined by its `tracking_id`. * * @param trackingId A unique id, which identifies the association of multiple events. This can i.e. * be a user guid, for events related to a user. It is important, that this id is * unique and immutable. * @param audit Audit information about this event. */ final case class DeleteEvent( trackingId: String, audit: de.nccloud.common.v0.models.Audit ) extends ReportingEvent { override val reportingEventType: ReportingEventType = ReportingEventType.DeleteEvent } /** * Single field of a topic schema. A field can be used for projecting, filtering * and sorting in reports. * * @param `type` The (scalar) type of the field. Fields can only be primitive types. * @param isArray Setting this to `true` means the field is an array of given type. * @param fields Nested fields for type `object`. When defining fields but not having set the * type to `object`, the fields will be ignored. When setting the type to `object`, * the fields need to be defined. * @param label A human-readable label for the field. * @param description A human-readable description of the field. */ final case class Field( `type`: de.nccloud.reporting.api.v0.models.ScalarType, isArray: Boolean, fields: _root_.scala.Option[Map[String, de.nccloud.reporting.api.v0.models.Field]] = None, label: _root_.scala.Option[String] = None, description: _root_.scala.Option[String] = None ) /** * Defines a condition for values. * * @param expression An SQL-like expression. * @param variables A map of values, which can be used in the expression. Variables can be access by * prepending them with `$`. */ final case class Filter( expression: _root_.scala.Option[String] = None, variables: _root_.scala.Option[Map[String, _root_.play.api.libs.json.JsValue]] = None ) /** * A single field of a projection schema. * * @param label A human-readable label for the field. * @param description A human-readable description for the field. * @param source The source of the field. Either `source` or `fields` must be set. * @param fields Defines nested fields for this projection. Either `source` or `fields` must be * set. */ final case class ProjectionField( label: _root_.scala.Option[String] = None, description: _root_.scala.Option[String] = None, source: _root_.scala.Option[de.nccloud.reporting.api.v0.models.ProjectionFieldSource] = None, fields: _root_.scala.Option[Map[String, de.nccloud.reporting.api.v0.models.ProjectionField]] = None ) /** * Represents the source for a single projection field from a topic's schema. * * @param topic Name of the originating topic. * @param path A slimmed down variant of [JSON * Path](https://gregsdennis.github.io/Manatee.Json/usage/path.html) to point to a * specific field in a topic's schema. * @param filter A conditional filter expression. The expression can contain variables, which * will be passed in when evaluating the projection. */ final case class ProjectionFieldSource( topic: String, path: String, filter: String ) /** * Form for querying and projecting data. * * @param view The name of a defined `view` used for projecting. If the view defines variables, * they must be provided as well. Either `view` or `projection` must be set. * @param projection Projected fields to return. Either `view` or `projection` must be set. * @param variables Variables to pass to the projection or the view. * @param sort The defined properties refer to the fields of the projection. */ final case class QueryForm( view: _root_.scala.Option[String] = None, projection: _root_.scala.Option[Map[String, de.nccloud.reporting.api.v0.models.ProjectionField]] = None, variables: Map[String, _root_.play.api.libs.json.JsValue], sort: _root_.scala.Option[Seq[de.nccloud.common.v0.models.Sort]] = None ) /** * The result of a query, returning data in a projected form. * * @param data The returned data in the projected form. */ final case class QueryResponse( page: de.nccloud.common.v0.models.PageResponse, data: _root_.play.api.libs.json.JsObject ) /** * Represents a single topic, which will be consumed by the reporting service. * * @param service Info about the producing service. * @param schema The schema of the topics' provided data. */ final case class Topic( name: String, service: de.nccloud.common.v0.models.ServiceInfo, schema: Map[String, de.nccloud.reporting.api.v0.models.Field] ) final case class TopicResponse( page: de.nccloud.common.v0.models.PageResponse, data: Seq[de.nccloud.reporting.api.v0.models.Topic] ) /** * Updates one or more data fields. * * @param trackingId A unique id, which identifies the association of multiple events. This can i.e. * be a user guid, for events related to a user. It is important, that this id is * unique and immutable. * @param payload One or more fields defined in the reporting schema, which will be updated. * @param audit Audit information about this event. */ final case class UpdateEvent( trackingId: String, payload: _root_.play.api.libs.json.JsObject, audit: de.nccloud.common.v0.models.Audit ) extends ReportingEvent { override val reportingEventType: ReportingEventType = ReportingEventType.UpdateEvent } /** * A stored view containing data from one or more topics. * * @param guid Globally unique identifier of the projection. * @param name Name of this projection used to reference it in a human-friendly way. The name * must be unique. * @param projection Projected fields of this view. * @param variables Definition of variables which can be passed to the view. All `scalar_type`s are * allowed, except `object`. */ final case class View( guid: _root_.java.util.UUID, name: String, projection: Map[String, de.nccloud.reporting.api.v0.models.ProjectionField], variables: Map[String, de.nccloud.reporting.api.v0.models.ScalarType] ) /** * Form for creating a new `view`. * * @param name Name of the view. * @param projection Projected fields of this view. * @param variables Definition of variables which can be passed to the view. All `scalar_type`s are * allowed, except `object`. */ final case class ViewForm( name: String, projection: Map[String, de.nccloud.reporting.api.v0.models.ProjectionField], variables: Map[String, de.nccloud.reporting.api.v0.models.ScalarType] ) final case class ViewResponse( page: de.nccloud.common.v0.models.PageResponse, data: Seq[de.nccloud.reporting.api.v0.models.View] ) /** * Provides future compatibility in clients - in the future, when a type is added * to the union ReportingEvent, it will need to be handled in the client code. This * implementation will deserialize these future types as an instance of this class. * * @param description Information about the type that we received that is undefined in this version of * the client. */ final case class ReportingEventUndefinedType( description: String ) extends ReportingEvent { override val reportingEventType: ReportingEventType = ReportingEventType.UNDEFINED(description) } /** * A type for a topic's schema field. */ sealed trait ScalarType extends _root_.scala.Product with _root_.scala.Serializable object ScalarType { case object Boolean extends ScalarType { override def toString = "boolean" } case object DateIso8601 extends ScalarType { override def toString = "date-iso8601" } case object DateTimeIso8601 extends ScalarType { override def toString = "date-time-iso8601" } case object Decimal extends ScalarType { override def toString = "decimal" } case object Double extends ScalarType { override def toString = "double" } case object Integer extends ScalarType { override def toString = "integer" } case object Long extends ScalarType { override def toString = "long" } case object String extends ScalarType { override def toString = "string" } case object Uuid extends ScalarType { override def toString = "uuid" } /** * Note: when a type is set to `object`, the additional fields **must** be defined * in the schema. */ case object Object extends ScalarType { override def toString = "object" } /** * UNDEFINED captures values that are sent either in error or * that were added by the server after this library was * generated. We want to make it easy and obvious to users of * this library to handle this case gracefully. * * We use all CAPS for the variable name to avoid collisions * with the camel cased values above. */ final case class UNDEFINED(override val toString: String) extends ScalarType /** * all returns a list of all the valid, known values. We use * lower case to avoid collisions with the camel cased values * above. */ val all: scala.List[ScalarType] = scala.List(Boolean, DateIso8601, DateTimeIso8601, Decimal, Double, Integer, Long, String, Uuid, Object) private val byName: Map[String, ScalarType] = all.map(x => x.toString.toLowerCase -> x).toMap def apply(value: String): ScalarType = fromString(value).getOrElse(UNDEFINED(value)) def fromString(value: String): _root_.scala.Option[ScalarType] = byName.get(value.toLowerCase) } } package de.nccloud.reporting.api.v0.models { package object json { import play.api.libs.json.__ import play.api.libs.json.JsString import play.api.libs.json.Writes import play.api.libs.functional.syntax._ import de.nccloud.common.v0.models.json._ import de.nccloud.reporting.api.v0.models.json._ private[v0] implicit val jsonReadsUUID: play.api.libs.json.Reads[_root_.java.util.UUID] = __.read[String].map { str => _root_.java.util.UUID.fromString(str) } private[v0] implicit val jsonWritesUUID: play.api.libs.json.Writes[_root_.java.util.UUID] = (x: _root_.java.util.UUID) => play.api.libs.json.JsString(x.toString) private[v0] implicit val jsonReadsJodaDateTime: play.api.libs.json.Reads[_root_.org.joda.time.DateTime] = __.read[String].map { str => _root_.org.joda.time.format.ISODateTimeFormat.dateTimeParser.parseDateTime(str) } private[v0] implicit val jsonWritesJodaDateTime: play.api.libs.json.Writes[_root_.org.joda.time.DateTime] = (x: _root_.org.joda.time.DateTime) => { play.api.libs.json.JsString(_root_.org.joda.time.format.ISODateTimeFormat.dateTime.print(x)) } private[v0] implicit val jsonReadsJodaLocalDate: play.api.libs.json.Reads[_root_.org.joda.time.LocalDate] = __.read[String].map { str => _root_.org.joda.time.format.ISODateTimeFormat.dateTimeParser.parseLocalDate(str) } private[v0] implicit val jsonWritesJodaLocalDate: play.api.libs.json.Writes[_root_.org.joda.time.LocalDate] = (x: _root_.org.joda.time.LocalDate) => { play.api.libs.json.JsString(_root_.org.joda.time.format.ISODateTimeFormat.date.print(x)) } implicit val jsonReadsReportingApiScalarType: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.ScalarType] = new play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.ScalarType] { def reads(js: play.api.libs.json.JsValue): play.api.libs.json.JsResult[de.nccloud.reporting.api.v0.models.ScalarType] = { js match { case v: play.api.libs.json.JsString => play.api.libs.json.JsSuccess(de.nccloud.reporting.api.v0.models.ScalarType(v.value)) case _ => { (js \ "value").validate[String] match { case play.api.libs.json.JsSuccess(v, _) => play.api.libs.json.JsSuccess(de.nccloud.reporting.api.v0.models.ScalarType(v)) case _: play.api.libs.json.JsError => (js \ "scalar_type").validate[String] match { case play.api.libs.json.JsSuccess(v, _) => play.api.libs.json.JsSuccess(de.nccloud.reporting.api.v0.models.ScalarType(v)) case err: play.api.libs.json.JsError => err } } } } } } def jsonWritesReportingApiScalarType(obj: de.nccloud.reporting.api.v0.models.ScalarType) = { play.api.libs.json.JsString(obj.toString) } def jsObjectScalarType(obj: de.nccloud.reporting.api.v0.models.ScalarType) = { play.api.libs.json.Json.obj("value" -> play.api.libs.json.JsString(obj.toString)) } implicit def jsonWritesReportingApiScalarType: play.api.libs.json.Writes[ScalarType] = { (obj: de.nccloud.reporting.api.v0.models.ScalarType) => { de.nccloud.reporting.api.v0.models.json.jsonWritesReportingApiScalarType(obj) } } implicit def jsonReadsReportingApiDeleteEvent: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.DeleteEvent] = { for { trackingId <- (__ \ "tracking_id").read[String] audit <- (__ \ "audit").read[de.nccloud.common.v0.models.Audit] } yield DeleteEvent(trackingId, audit) } def jsObjectDeleteEvent(obj: de.nccloud.reporting.api.v0.models.DeleteEvent): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "tracking_id" -> play.api.libs.json.JsString(obj.trackingId), "audit" -> de.nccloud.common.v0.models.json.jsObjectAudit(obj.audit) ) ++ play.api.libs.json.Json.obj("type" -> "delete_event") } implicit def jsonWritesReportingApiDeleteEvent: play.api.libs.json.Writes[DeleteEvent] = { (obj: de.nccloud.reporting.api.v0.models.DeleteEvent) => { de.nccloud.reporting.api.v0.models.json.jsObjectDeleteEvent(obj) } } implicit def jsonReadsReportingApiField: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.Field] = { for { `type` <- (__ \ "type").read[de.nccloud.reporting.api.v0.models.ScalarType] isArray <- (__ \ "is_array").read[Boolean] fields <- (__ \ "fields").lazyReadNullable(play.api.libs.json.Reads.of[Map[String, de.nccloud.reporting.api.v0.models.Field]]) label <- (__ \ "label").readNullable[String] description <- (__ \ "description").readNullable[String] } yield Field(`type`, isArray, fields, label, description) } def jsObjectField(obj: de.nccloud.reporting.api.v0.models.Field): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "type" -> play.api.libs.json.JsString(obj.`type`.toString), "is_array" -> play.api.libs.json.JsBoolean(obj.isArray) ) ++ (obj.fields match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("fields" -> play.api.libs.json.Json.toJson(x)) }) ++ (obj.label match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("label" -> play.api.libs.json.JsString(x)) }) ++ (obj.description match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("description" -> play.api.libs.json.JsString(x)) }) } implicit def jsonWritesReportingApiField: play.api.libs.json.Writes[Field] = { (obj: de.nccloud.reporting.api.v0.models.Field) => { de.nccloud.reporting.api.v0.models.json.jsObjectField(obj) } } implicit def jsonReadsReportingApiFilter: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.Filter] = { for { expression <- (__ \ "expression").readNullable[String] variables <- (__ \ "variables").readNullable[Map[String, _root_.play.api.libs.json.JsValue]] } yield Filter(expression, variables) } def jsObjectFilter(obj: de.nccloud.reporting.api.v0.models.Filter): play.api.libs.json.JsObject = { (obj.expression match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("expression" -> play.api.libs.json.JsString(x)) }) ++ (obj.variables match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("variables" -> play.api.libs.json.Json.toJson(x)) }) } implicit def jsonWritesReportingApiFilter: play.api.libs.json.Writes[Filter] = { (obj: de.nccloud.reporting.api.v0.models.Filter) => { de.nccloud.reporting.api.v0.models.json.jsObjectFilter(obj) } } implicit def jsonReadsReportingApiProjectionField: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.ProjectionField] = { for { label <- (__ \ "label").readNullable[String] description <- (__ \ "description").readNullable[String] source <- (__ \ "source").readNullable[de.nccloud.reporting.api.v0.models.ProjectionFieldSource] fields <- (__ \ "fields").lazyReadNullable(play.api.libs.json.Reads.of[Map[String, de.nccloud.reporting.api.v0.models.ProjectionField]]) } yield ProjectionField(label, description, source, fields) } def jsObjectProjectionField(obj: de.nccloud.reporting.api.v0.models.ProjectionField): play.api.libs.json.JsObject = { (obj.label match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("label" -> play.api.libs.json.JsString(x)) }) ++ (obj.description match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("description" -> play.api.libs.json.JsString(x)) }) ++ (obj.source match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("source" -> de.nccloud.reporting.api.v0.models.json.jsObjectProjectionFieldSource(x)) }) ++ (obj.fields match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("fields" -> play.api.libs.json.Json.toJson(x)) }) } implicit def jsonWritesReportingApiProjectionField: play.api.libs.json.Writes[ProjectionField] = { (obj: de.nccloud.reporting.api.v0.models.ProjectionField) => { de.nccloud.reporting.api.v0.models.json.jsObjectProjectionField(obj) } } implicit def jsonReadsReportingApiProjectionFieldSource: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.ProjectionFieldSource] = { for { topic <- (__ \ "topic").read[String] path <- (__ \ "path").read[String] filter <- (__ \ "filter").read[String] } yield ProjectionFieldSource(topic, path, filter) } def jsObjectProjectionFieldSource(obj: de.nccloud.reporting.api.v0.models.ProjectionFieldSource): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "topic" -> play.api.libs.json.JsString(obj.topic), "path" -> play.api.libs.json.JsString(obj.path), "filter" -> play.api.libs.json.JsString(obj.filter) ) } implicit def jsonWritesReportingApiProjectionFieldSource: play.api.libs.json.Writes[ProjectionFieldSource] = { (obj: de.nccloud.reporting.api.v0.models.ProjectionFieldSource) => { de.nccloud.reporting.api.v0.models.json.jsObjectProjectionFieldSource(obj) } } implicit def jsonReadsReportingApiQueryForm: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.QueryForm] = { for { view <- (__ \ "view").readNullable[String] projection <- (__ \ "projection").readNullable[Map[String, de.nccloud.reporting.api.v0.models.ProjectionField]] variables <- (__ \ "variables").read[Map[String, _root_.play.api.libs.json.JsValue]] sort <- (__ \ "sort").readNullable[Seq[de.nccloud.common.v0.models.Sort]] } yield QueryForm(view, projection, variables, sort) } def jsObjectQueryForm(obj: de.nccloud.reporting.api.v0.models.QueryForm): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "variables" -> play.api.libs.json.Json.toJson(obj.variables) ) ++ (obj.view match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("view" -> play.api.libs.json.JsString(x)) }) ++ (obj.projection match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("projection" -> play.api.libs.json.Json.toJson(x)) }) ++ (obj.sort match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("sort" -> play.api.libs.json.Json.toJson(x)) }) } implicit def jsonWritesReportingApiQueryForm: play.api.libs.json.Writes[QueryForm] = { (obj: de.nccloud.reporting.api.v0.models.QueryForm) => { de.nccloud.reporting.api.v0.models.json.jsObjectQueryForm(obj) } } implicit def jsonReadsReportingApiQueryResponse: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.QueryResponse] = { for { page <- (__ \ "page").read[de.nccloud.common.v0.models.PageResponse] data <- (__ \ "data").read[_root_.play.api.libs.json.JsObject] } yield QueryResponse(page, data) } def jsObjectQueryResponse(obj: de.nccloud.reporting.api.v0.models.QueryResponse): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "page" -> de.nccloud.common.v0.models.json.jsObjectPageResponse(obj.page), "data" -> obj.data ) } implicit def jsonWritesReportingApiQueryResponse: play.api.libs.json.Writes[QueryResponse] = { (obj: de.nccloud.reporting.api.v0.models.QueryResponse) => { de.nccloud.reporting.api.v0.models.json.jsObjectQueryResponse(obj) } } implicit def jsonReadsReportingApiTopic: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.Topic] = { for { name <- (__ \ "name").read[String] service <- (__ \ "service").read[de.nccloud.common.v0.models.ServiceInfo] schema <- (__ \ "schema").read[Map[String, de.nccloud.reporting.api.v0.models.Field]] } yield Topic(name, service, schema) } def jsObjectTopic(obj: de.nccloud.reporting.api.v0.models.Topic): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "name" -> play.api.libs.json.JsString(obj.name), "service" -> de.nccloud.common.v0.models.json.jsObjectServiceInfo(obj.service), "schema" -> play.api.libs.json.Json.toJson(obj.schema) ) } implicit def jsonWritesReportingApiTopic: play.api.libs.json.Writes[Topic] = { (obj: de.nccloud.reporting.api.v0.models.Topic) => { de.nccloud.reporting.api.v0.models.json.jsObjectTopic(obj) } } implicit def jsonReadsReportingApiTopicResponse: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.TopicResponse] = { for { page <- (__ \ "page").read[de.nccloud.common.v0.models.PageResponse] data <- (__ \ "data").read[Seq[de.nccloud.reporting.api.v0.models.Topic]] } yield TopicResponse(page, data) } def jsObjectTopicResponse(obj: de.nccloud.reporting.api.v0.models.TopicResponse): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "page" -> de.nccloud.common.v0.models.json.jsObjectPageResponse(obj.page), "data" -> play.api.libs.json.Json.toJson(obj.data) ) } implicit def jsonWritesReportingApiTopicResponse: play.api.libs.json.Writes[TopicResponse] = { (obj: de.nccloud.reporting.api.v0.models.TopicResponse) => { de.nccloud.reporting.api.v0.models.json.jsObjectTopicResponse(obj) } } implicit def jsonReadsReportingApiUpdateEvent: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.UpdateEvent] = { for { trackingId <- (__ \ "tracking_id").read[String] payload <- (__ \ "payload").read[_root_.play.api.libs.json.JsObject] audit <- (__ \ "audit").read[de.nccloud.common.v0.models.Audit] } yield UpdateEvent(trackingId, payload, audit) } def jsObjectUpdateEvent(obj: de.nccloud.reporting.api.v0.models.UpdateEvent): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "tracking_id" -> play.api.libs.json.JsString(obj.trackingId), "payload" -> obj.payload, "audit" -> de.nccloud.common.v0.models.json.jsObjectAudit(obj.audit) ) ++ play.api.libs.json.Json.obj("type" -> "update_event") } implicit def jsonWritesReportingApiUpdateEvent: play.api.libs.json.Writes[UpdateEvent] = { (obj: de.nccloud.reporting.api.v0.models.UpdateEvent) => { de.nccloud.reporting.api.v0.models.json.jsObjectUpdateEvent(obj) } } implicit def jsonReadsReportingApiView: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.View] = { for { guid <- (__ \ "guid").read[_root_.java.util.UUID] name <- (__ \ "name").read[String] projection <- (__ \ "projection").read[Map[String, de.nccloud.reporting.api.v0.models.ProjectionField]] variables <- (__ \ "variables").read[Map[String, de.nccloud.reporting.api.v0.models.ScalarType]] } yield View(guid, name, projection, variables) } def jsObjectView(obj: de.nccloud.reporting.api.v0.models.View): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "guid" -> play.api.libs.json.JsString(obj.guid.toString), "name" -> play.api.libs.json.JsString(obj.name), "projection" -> play.api.libs.json.Json.toJson(obj.projection), "variables" -> play.api.libs.json.Json.toJson(obj.variables) ) } implicit def jsonWritesReportingApiView: play.api.libs.json.Writes[View] = { (obj: de.nccloud.reporting.api.v0.models.View) => { de.nccloud.reporting.api.v0.models.json.jsObjectView(obj) } } implicit def jsonReadsReportingApiViewForm: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.ViewForm] = { for { name <- (__ \ "name").read[String] projection <- (__ \ "projection").read[Map[String, de.nccloud.reporting.api.v0.models.ProjectionField]] variables <- (__ \ "variables").read[Map[String, de.nccloud.reporting.api.v0.models.ScalarType]] } yield ViewForm(name, projection, variables) } def jsObjectViewForm(obj: de.nccloud.reporting.api.v0.models.ViewForm): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "name" -> play.api.libs.json.JsString(obj.name), "projection" -> play.api.libs.json.Json.toJson(obj.projection), "variables" -> play.api.libs.json.Json.toJson(obj.variables) ) } implicit def jsonWritesReportingApiViewForm: play.api.libs.json.Writes[ViewForm] = { (obj: de.nccloud.reporting.api.v0.models.ViewForm) => { de.nccloud.reporting.api.v0.models.json.jsObjectViewForm(obj) } } implicit def jsonReadsReportingApiViewResponse: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.ViewResponse] = { for { page <- (__ \ "page").read[de.nccloud.common.v0.models.PageResponse] data <- (__ \ "data").read[Seq[de.nccloud.reporting.api.v0.models.View]] } yield ViewResponse(page, data) } def jsObjectViewResponse(obj: de.nccloud.reporting.api.v0.models.ViewResponse): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "page" -> de.nccloud.common.v0.models.json.jsObjectPageResponse(obj.page), "data" -> play.api.libs.json.Json.toJson(obj.data) ) } implicit def jsonWritesReportingApiViewResponse: play.api.libs.json.Writes[ViewResponse] = { (obj: de.nccloud.reporting.api.v0.models.ViewResponse) => { de.nccloud.reporting.api.v0.models.json.jsObjectViewResponse(obj) } } implicit def jsonReadsReportingApiReportingEvent: play.api.libs.json.Reads[de.nccloud.reporting.api.v0.models.ReportingEvent] = (js: play.api.libs.json.JsValue) => { def readDiscriminator(discriminator: String) = { discriminator match { case "update_event" => de.nccloud.reporting.api.v0.models.json.jsonReadsReportingApiUpdateEvent.reads(js) case "delete_event" => de.nccloud.reporting.api.v0.models.json.jsonReadsReportingApiDeleteEvent.reads(js) case other => play.api.libs.json.JsSuccess(de.nccloud.reporting.api.v0.models.ReportingEventUndefinedType(other)) } } (js \ "type").validate[String] match { case e: play.api.libs.json.JsError => e case s: play.api.libs.json.JsSuccess[String] => readDiscriminator(s.value) } } def jsObjectReportingEvent(obj: de.nccloud.reporting.api.v0.models.ReportingEvent): play.api.libs.json.JsObject = { obj match { case x: de.nccloud.reporting.api.v0.models.UpdateEvent => de.nccloud.reporting.api.v0.models.json.jsObjectUpdateEvent(x) case x: de.nccloud.reporting.api.v0.models.DeleteEvent => de.nccloud.reporting.api.v0.models.json.jsObjectDeleteEvent(x) case other => { sys.error(s"The type[${other.getClass.getName}] has no JSON writer") } } } implicit def jsonWritesReportingApiReportingEvent: play.api.libs.json.Writes[ReportingEvent] = { (obj: de.nccloud.reporting.api.v0.models.ReportingEvent) => { de.nccloud.reporting.api.v0.models.json.jsObjectReportingEvent(obj) } } } } package de.nccloud.reporting.api.v0 { object Bindables { import play.api.mvc.{PathBindable, QueryStringBindable} // import models directly for backwards compatibility with prior versions of the generator import Core._ import Models._ object Core { implicit def pathBindableDateTimeIso8601(implicit stringBinder: QueryStringBindable[String]): PathBindable[_root_.org.joda.time.DateTime] = ApibuilderPathBindable(ApibuilderTypes.dateTimeIso8601) implicit def queryStringBindableDateTimeIso8601(implicit stringBinder: QueryStringBindable[String]): QueryStringBindable[_root_.org.joda.time.DateTime] = ApibuilderQueryStringBindable(ApibuilderTypes.dateTimeIso8601) implicit def pathBindableDateIso8601(implicit stringBinder: QueryStringBindable[String]): PathBindable[_root_.org.joda.time.LocalDate] = ApibuilderPathBindable(ApibuilderTypes.dateIso8601) implicit def queryStringBindableDateIso8601(implicit stringBinder: QueryStringBindable[String]): QueryStringBindable[_root_.org.joda.time.LocalDate] = ApibuilderQueryStringBindable(ApibuilderTypes.dateIso8601) } object Models { import de.nccloud.reporting.api.v0.models._ val scalarTypeConverter: ApibuilderTypeConverter[de.nccloud.reporting.api.v0.models.ScalarType] = new ApibuilderTypeConverter[de.nccloud.reporting.api.v0.models.ScalarType] { override def convert(value: String): de.nccloud.reporting.api.v0.models.ScalarType = de.nccloud.reporting.api.v0.models.ScalarType(value) override def convert(value: de.nccloud.reporting.api.v0.models.ScalarType): String = value.toString override def example: de.nccloud.reporting.api.v0.models.ScalarType = de.nccloud.reporting.api.v0.models.ScalarType.Boolean override def validValues: Seq[de.nccloud.reporting.api.v0.models.ScalarType] = de.nccloud.reporting.api.v0.models.ScalarType.all } implicit def pathBindableScalarType(implicit stringBinder: QueryStringBindable[String]): PathBindable[de.nccloud.reporting.api.v0.models.ScalarType] = ApibuilderPathBindable(scalarTypeConverter) implicit def queryStringBindableScalarType(implicit stringBinder: QueryStringBindable[String]): QueryStringBindable[de.nccloud.reporting.api.v0.models.ScalarType] = ApibuilderQueryStringBindable(scalarTypeConverter) } trait ApibuilderTypeConverter[T] { def convert(value: String): T def convert(value: T): String def example: T def validValues: Seq[T] = Nil def errorMessage(key: String, value: String, ex: java.lang.Exception): String = { val base = s"Invalid value '$value' for parameter '$key'. " validValues.toList match { case Nil => base + "Ex: " + convert(example) case values => base + ". Valid values are: " + values.mkString("'", "', '", "'") } } } object ApibuilderTypes { val dateTimeIso8601: ApibuilderTypeConverter[_root_.org.joda.time.DateTime] = new ApibuilderTypeConverter[_root_.org.joda.time.DateTime] { override def convert(value: String): _root_.org.joda.time.DateTime = _root_.org.joda.time.format.ISODateTimeFormat.dateTimeParser.parseDateTime(value) override def convert(value: _root_.org.joda.time.DateTime): String = _root_.org.joda.time.format.ISODateTimeFormat.dateTime.print(value) override def example: _root_.org.joda.time.DateTime = _root_.org.joda.time.DateTime.now } val dateIso8601: ApibuilderTypeConverter[_root_.org.joda.time.LocalDate] = new ApibuilderTypeConverter[_root_.org.joda.time.LocalDate] { override def convert(value: String): _root_.org.joda.time.LocalDate = _root_.org.joda.time.format.ISODateTimeFormat.dateTimeParser.parseLocalDate(value) override def convert(value: _root_.org.joda.time.LocalDate): String = _root_.org.joda.time.format.ISODateTimeFormat.date.print(value) override def example: _root_.org.joda.time.LocalDate = _root_.org.joda.time.LocalDate.now } } final case class ApibuilderQueryStringBindable[T]( converters: ApibuilderTypeConverter[T] ) extends QueryStringBindable[T] { override def bind(key: String, params: Map[String, Seq[String]]): _root_.scala.Option[_root_.scala.Either[String, T]] = { params.getOrElse(key, Nil).headOption.map { v => try { Right( converters.convert(v) ) } catch { case ex: java.lang.Exception => Left( converters.errorMessage(key, v, ex) ) } } } override def unbind(key: String, value: T): String = { s"$key=${converters.convert(value)}" } } final case class ApibuilderPathBindable[T]( converters: ApibuilderTypeConverter[T] ) extends PathBindable[T] { override def bind(key: String, value: String): _root_.scala.Either[String, T] = { try { Right( converters.convert(value) ) } catch { case ex: java.lang.Exception => Left( converters.errorMessage(key, value, ex) ) } } override def unbind(key: String, value: T): String = { converters.convert(value) } } } } package de.nccloud.reporting.api.v0 { object Constants { val Namespace = "de.nccloud.reporting.api.v0" val UserAgent = "apibuilder app.apibuilder.io/nccloud/reporting-api/0.0.1/play_2_6_client" val Version = "0.0.1" val VersionMajor = 0 } class Client( ws: play.api.libs.ws.WSClient, val baseUrl: String, auth: scala.Option[de.nccloud.reporting.api.v0.Authorization] = None, defaultHeaders: Seq[(String, String)] = Nil ) extends interfaces.Client { import de.nccloud.common.v0.models.json._ import de.nccloud.reporting.api.v0.models.json._ private val logger = play.api.Logger("de.nccloud.reporting.api.v0.Client") logger.info(s"Initializing de.nccloud.reporting.api.v0.Client for url $baseUrl") def queryResponses: QueryResponses = QueryResponses def topics: Topics = Topics def views: Views = Views object QueryResponses extends QueryResponses { override def post( queryForm: de.nccloud.reporting.api.v0.models.QueryForm, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.QueryResponse] = { val payload = play.api.libs.json.Json.toJson(queryForm) _executeRequest("POST", s"/query", body = Some(payload), requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.de.nccloud.reporting.api.v0.Client.parseJson("de.nccloud.reporting.api.v0.models.QueryResponse", r, _.validate[de.nccloud.reporting.api.v0.models.QueryResponse]) case r if r.status == 400 => throw de.nccloud.reporting.api.v0.errors.GenericErrorsResponse(r) case r => throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200, 400") } } } object Topics extends Topics { override def get( offset: Int = 0, limit: Int = 25, sortBy: String = "name", direction: de.nccloud.common.v0.models.SortDirection = de.nccloud.common.v0.models.SortDirection.Asc, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.TopicResponse] = { val queryParameters = Seq( Some("offset" -> offset.toString), Some("limit" -> limit.toString), Some("sort_by" -> sortBy), Some("direction" -> direction.toString) ).flatten _executeRequest("GET", s"/topics", queryParameters = queryParameters, requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.de.nccloud.reporting.api.v0.Client.parseJson("de.nccloud.reporting.api.v0.models.TopicResponse", r, _.validate[de.nccloud.reporting.api.v0.models.TopicResponse]) case r => throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } override def getByGuid( guid: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.Topic] = { _executeRequest("GET", s"/topics/${play.utils.UriEncoding.encodePathSegment(guid, "UTF-8")}", requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.de.nccloud.reporting.api.v0.Client.parseJson("de.nccloud.reporting.api.v0.models.Topic", r, _.validate[de.nccloud.reporting.api.v0.models.Topic]) case r if r.status == 404 => throw de.nccloud.reporting.api.v0.errors.UnitResponse(r.status) case r => throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200, 404") } } } object Views extends Views { override def get( offset: Int = 0, limit: Int = 25, sortBy: String = "name", direction: de.nccloud.common.v0.models.SortDirection = de.nccloud.common.v0.models.SortDirection.Asc, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.ViewResponse] = { val queryParameters = Seq( Some("offset" -> offset.toString), Some("limit" -> limit.toString), Some("sort_by" -> sortBy), Some("direction" -> direction.toString) ).flatten _executeRequest("GET", s"/views", queryParameters = queryParameters, requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.de.nccloud.reporting.api.v0.Client.parseJson("de.nccloud.reporting.api.v0.models.ViewResponse", r, _.validate[de.nccloud.reporting.api.v0.models.ViewResponse]) case r => throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } override def getByGuid( guid: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.View] = { _executeRequest("GET", s"/views/${guid}", requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.de.nccloud.reporting.api.v0.Client.parseJson("de.nccloud.reporting.api.v0.models.View", r, _.validate[de.nccloud.reporting.api.v0.models.View]) case r if r.status == 404 => throw de.nccloud.reporting.api.v0.errors.UnitResponse(r.status) case r => throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200, 404") } } override def post( viewForm: de.nccloud.reporting.api.v0.models.ViewForm, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.View] = { val payload = play.api.libs.json.Json.toJson(viewForm) _executeRequest("POST", s"/views", body = Some(payload), requestHeaders = requestHeaders).map { case r if r.status == 201 => _root_.de.nccloud.reporting.api.v0.Client.parseJson("de.nccloud.reporting.api.v0.models.View", r, _.validate[de.nccloud.reporting.api.v0.models.View]) case r if r.status == 400 => throw de.nccloud.reporting.api.v0.errors.GenericErrorsResponse(r) case r => throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 201, 400") } } override def putByGuid( guid: _root_.java.util.UUID, viewForm: de.nccloud.reporting.api.v0.models.ViewForm, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.View] = { val payload = play.api.libs.json.Json.toJson(viewForm) _executeRequest("PUT", s"/views/${guid}", body = Some(payload), requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.de.nccloud.reporting.api.v0.Client.parseJson("de.nccloud.reporting.api.v0.models.View", r, _.validate[de.nccloud.reporting.api.v0.models.View]) case r if r.status == 400 => throw de.nccloud.reporting.api.v0.errors.GenericErrorsResponse(r) case r if r.status == 404 => throw de.nccloud.reporting.api.v0.errors.UnitResponse(r.status) case r => throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200, 400, 404") } } override def deleteByGuid( guid: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { _executeRequest("DELETE", s"/views/${guid}", requestHeaders = requestHeaders).map { case r if r.status == 200 => () case r if r.status == 404 => throw de.nccloud.reporting.api.v0.errors.UnitResponse(r.status) case r => throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200, 404") } } } def _requestHolder(path: String): play.api.libs.ws.WSRequest = { val holder = ws.url(baseUrl + path).addHttpHeaders( "User-Agent" -> Constants.UserAgent, "X-Apidoc-Version" -> Constants.Version, "X-Apidoc-Version-Major" -> Constants.VersionMajor.toString ).addHttpHeaders(defaultHeaders: _*) auth.fold(holder) { case Authorization.Basic(username, password) => { holder.withAuth(username, password.getOrElse(""), play.api.libs.ws.WSAuthScheme.BASIC) } } } def _logRequest(method: String, req: play.api.libs.ws.WSRequest): play.api.libs.ws.WSRequest = { val queryComponents = for { (name, values) <- req.queryString value <- values } yield s"$name=$value" val url = s"${req.url}${queryComponents.mkString("?", "&", "")}" auth.fold(logger.info(s"curl -X $method '$url'")) { _ => logger.info(s"curl -X $method -u '[REDACTED]:' '$url'") } req } def _executeRequest( method: String, path: String, queryParameters: Seq[(String, String)] = Nil, requestHeaders: Seq[(String, String)] = Nil, body: Option[play.api.libs.json.JsValue] = None ): scala.concurrent.Future[play.api.libs.ws.WSResponse] = { method.toUpperCase match { case "GET" => { _logRequest("GET", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).get() } case "POST" => { _logRequest("POST", _requestHolder(path).addHttpHeaders(_withJsonContentType(requestHeaders): _*).addQueryStringParameters(queryParameters: _*)).post(body.getOrElse(play.api.libs.json.Json.obj())) } case "PUT" => { _logRequest("PUT", _requestHolder(path).addHttpHeaders(_withJsonContentType(requestHeaders): _*).addQueryStringParameters(queryParameters: _*)).put(body.getOrElse(play.api.libs.json.Json.obj())) } case "PATCH" => { _logRequest("PATCH", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).patch(body.getOrElse(play.api.libs.json.Json.obj())) } case "DELETE" => { _logRequest("DELETE", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).delete() } case "HEAD" => { _logRequest("HEAD", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).head() } case "OPTIONS" => { _logRequest("OPTIONS", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).options() } case _ => { _logRequest(method, _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)) sys.error("Unsupported method[%s]".format(method)) } } } /** * Adds a Content-Type: application/json header unless the specified requestHeaders * already contain a Content-Type header */ def _withJsonContentType(headers: Seq[(String, String)]): Seq[(String, String)] = { headers.find { _._1.toUpperCase == "CONTENT-TYPE" } match { case None => headers ++ Seq("Content-Type" -> "application/json; charset=UTF-8") case Some(_) => headers } } } object Client { def parseJson[T]( className: String, r: play.api.libs.ws.WSResponse, f: (play.api.libs.json.JsValue => play.api.libs.json.JsResult[T]) ): T = { f(play.api.libs.json.Json.parse(r.body)) match { case play.api.libs.json.JsSuccess(x, _) => x case play.api.libs.json.JsError(errors) => { throw de.nccloud.reporting.api.v0.errors.FailedRequest(r.status, s"Invalid json for class[" + className + "]: " + errors.mkString(" ")) } } } } sealed trait Authorization extends _root_.scala.Product with _root_.scala.Serializable object Authorization { final case class Basic(username: String, password: Option[String] = None) extends Authorization } package interfaces { trait Client { def baseUrl: String def queryResponses: de.nccloud.reporting.api.v0.QueryResponses def topics: de.nccloud.reporting.api.v0.Topics def views: de.nccloud.reporting.api.v0.Views } } trait QueryResponses { def post( queryForm: de.nccloud.reporting.api.v0.models.QueryForm, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.QueryResponse] } trait Topics { def get( offset: Int = 0, limit: Int = 25, sortBy: String = "name", direction: de.nccloud.common.v0.models.SortDirection = de.nccloud.common.v0.models.SortDirection.Asc, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.TopicResponse] def getByGuid( guid: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.Topic] } trait Views { def get( offset: Int = 0, limit: Int = 25, sortBy: String = "name", direction: de.nccloud.common.v0.models.SortDirection = de.nccloud.common.v0.models.SortDirection.Asc, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.ViewResponse] def getByGuid( guid: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.View] def post( viewForm: de.nccloud.reporting.api.v0.models.ViewForm, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.View] def putByGuid( guid: _root_.java.util.UUID, viewForm: de.nccloud.reporting.api.v0.models.ViewForm, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[de.nccloud.reporting.api.v0.models.View] def deleteByGuid( guid: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] } package errors { import de.nccloud.common.v0.models.json._ import de.nccloud.reporting.api.v0.models.json._ final case class GenericErrorsResponse( response: play.api.libs.ws.WSResponse, message: Option[String] = None ) extends Exception(message.getOrElse(s"${response.status}: ${response.body}")) { lazy val genericErrors = _root_.de.nccloud.reporting.api.v0.Client.parseJson("Seq[de.nccloud.common.v0.models.GenericError]", response, _.validate[Seq[de.nccloud.common.v0.models.GenericError]]) } final case class UnitResponse(status: Int) extends Exception(s"HTTP $status") final case class FailedRequest(responseCode: Int, message: String, requestUri: Option[_root_.java.net.URI] = None) extends _root_.java.lang.Exception(s"HTTP $responseCode: $message") } }