/** * Generated by API Builder - https://www.apibuilder.io * Service version: 0.0.1-dev * User agent: apibuilder app.apibuilder.io/shopr/clickouts-api/0.0.1-dev/play_2_x_scala_3_standalone_json */ package com.shopr.api.clickouts.api.v0.models { /** * Represents an Offer click-out. It contains all the information needed to * properly identify the offer, trace it ot the user navigating from search page, * and relevant information about the offer at the click-out moment (e.g.: price, * lowest price among other offers, etc.) * * @param productId Product identifier * @param seller Seller/Retailer unique identifier * @param sellerProductId Product as identifier given by the seller/retailer * @param price Offer price at the moment of the click-out * @param deepUrl Full product URL at the retailer side * @param lowestPrice Lowest price among all offers * @param highestPrice Seller/Retailer unique identifier * @param offerCount Number of offers * @param offerPosition Offer position among other offers (e.g.: first, second, etc.) * @param categoryId Category where the product was put into * @param tracking Tracking information * @param creationTime When this click-out happened */ final case class Clickout( productId: String, seller: String, sellerProductId: String, price: BigDecimal, deepUrl: String, lowestPrice: BigDecimal, highestPrice: BigDecimal, offerCount: Int = 1, offerPosition: Int, categoryId: String, tracking: com.shopr.api.clickouts.api.v0.models.Tracking, creationTime: _root_.org.joda.time.DateTime ) /** * @param code Machine readable code for this specific error message * @param localizedStringCode A localized description of the error code */ final case class ErrorCode( code: String, localizedStringCode: String ) /** * @param message User-friendly message. * @param errorCodes List of errors that may happened all together. * @param fingerprint The request fingerprint associated with this error. */ final case class ErrorResponse( message: _root_.scala.Option[String] = None, errorCodes: Seq[com.shopr.api.clickouts.api.v0.models.ErrorCode], fingerprint: _root_.scala.Option[String] = None ) /** * Response for ping, health check and version */ final case class Status( response: String ) /** * Series of attributes for tracking purposes * * @param origin Client originating the order request essentially any of the values of the * client_origin enum. * @param referrer Optional page referrer. */ final case class Tracking( ipAddress: String, origin: com.shopr.api.clickouts.api.v0.models.ClientOrigin, userAgent: _root_.scala.Option[String] = None, referrer: _root_.scala.Option[String] = None ) /** * Describes the client where the request for a clickout has originated. */ sealed trait ClientOrigin extends _root_.scala.Product with _root_.scala.Serializable object ClientOrigin { /** * The Shopr website */ case object ShoprWebsite extends ClientOrigin { override def toString = "shopr_website" } /** * The Shopr website, but from a mobile. */ case object ShoprMobileWeb extends ClientOrigin { override def toString = "shopr_mobile_web" } /** * IPhone native application. */ case object ShoprIphone extends ClientOrigin { override def toString = "shopr_iphone" } /** * Native application running on an IPad. */ case object ShoprIpad extends ClientOrigin { override def toString = "shopr_ipad" } /** * Android native application. */ case object ShoprAndroid extends ClientOrigin { override def toString = "shopr_android" } /** * 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 ClientOrigin /** * 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[ClientOrigin] = scala.List(ShoprWebsite, ShoprMobileWeb, ShoprIphone, ShoprIpad, ShoprAndroid) private val byName: Map[String, ClientOrigin] = all.map(x => x.toString.toLowerCase -> x).toMap def apply(value: String): ClientOrigin = fromString(value).getOrElse(UNDEFINED(value)) def fromString(value: String): _root_.scala.Option[ClientOrigin] = byName.get(value.toLowerCase) } } package com.shopr.api.clickouts.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 com.shopr.api.clickouts.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 jsonReadsClickoutsApiClientOrigin: play.api.libs.json.Reads[com.shopr.api.clickouts.api.v0.models.ClientOrigin] = new play.api.libs.json.Reads[com.shopr.api.clickouts.api.v0.models.ClientOrigin] { def reads(js: play.api.libs.json.JsValue): play.api.libs.json.JsResult[com.shopr.api.clickouts.api.v0.models.ClientOrigin] = { js match { case v: play.api.libs.json.JsString => play.api.libs.json.JsSuccess(com.shopr.api.clickouts.api.v0.models.ClientOrigin(v.value)) case _ => { (js \ "value").validate[String] match { case play.api.libs.json.JsSuccess(v, _) => play.api.libs.json.JsSuccess(com.shopr.api.clickouts.api.v0.models.ClientOrigin(v)) case _: play.api.libs.json.JsError => (js \ "client_origin").validate[String] match { case play.api.libs.json.JsSuccess(v, _) => play.api.libs.json.JsSuccess(com.shopr.api.clickouts.api.v0.models.ClientOrigin(v)) case err: play.api.libs.json.JsError => err } } } } } } def jsonWritesClickoutsApiClientOrigin(obj: com.shopr.api.clickouts.api.v0.models.ClientOrigin) = { play.api.libs.json.JsString(obj.toString) } def jsObjectClientOrigin(obj: com.shopr.api.clickouts.api.v0.models.ClientOrigin) = { play.api.libs.json.Json.obj("value" -> play.api.libs.json.JsString(obj.toString)) } implicit def jsonWritesClickoutsApiClientOrigin: play.api.libs.json.Writes[ClientOrigin] = { (obj: com.shopr.api.clickouts.api.v0.models.ClientOrigin) => { com.shopr.api.clickouts.api.v0.models.json.jsonWritesClickoutsApiClientOrigin(obj) } } implicit def jsonReadsClickoutsApiClickout: play.api.libs.json.Reads[com.shopr.api.clickouts.api.v0.models.Clickout] = { for { productId <- (__ \ "productId").read[String] seller <- (__ \ "seller").read[String] sellerProductId <- (__ \ "sellerProductId").read[String] price <- (__ \ "price").read[BigDecimal] deepUrl <- (__ \ "deepUrl").read[String] lowestPrice <- (__ \ "lowestPrice").read[BigDecimal] highestPrice <- (__ \ "highestPrice").read[BigDecimal] offerCount <- (__ \ "offerCount").read[Int] offerPosition <- (__ \ "offerPosition").read[Int] categoryId <- (__ \ "categoryId").read[String] tracking <- (__ \ "tracking").read[com.shopr.api.clickouts.api.v0.models.Tracking] creationTime <- (__ \ "creationTime").read[_root_.org.joda.time.DateTime] } yield Clickout(productId, seller, sellerProductId, price, deepUrl, lowestPrice, highestPrice, offerCount, offerPosition, categoryId, tracking, creationTime) } def jsObjectClickout(obj: com.shopr.api.clickouts.api.v0.models.Clickout): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "productId" -> play.api.libs.json.JsString(obj.productId), "seller" -> play.api.libs.json.JsString(obj.seller), "sellerProductId" -> play.api.libs.json.JsString(obj.sellerProductId), "price" -> play.api.libs.json.JsNumber(obj.price), "deepUrl" -> play.api.libs.json.JsString(obj.deepUrl), "lowestPrice" -> play.api.libs.json.JsNumber(obj.lowestPrice), "highestPrice" -> play.api.libs.json.JsNumber(obj.highestPrice), "offerCount" -> play.api.libs.json.JsNumber(obj.offerCount), "offerPosition" -> play.api.libs.json.JsNumber(obj.offerPosition), "categoryId" -> play.api.libs.json.JsString(obj.categoryId), "tracking" -> com.shopr.api.clickouts.api.v0.models.json.jsObjectTracking(obj.tracking), "creationTime" -> play.api.libs.json.JsString(_root_.org.joda.time.format.ISODateTimeFormat.dateTime.print(obj.creationTime)) ) } implicit def jsonWritesClickoutsApiClickout: play.api.libs.json.Writes[Clickout] = { (obj: com.shopr.api.clickouts.api.v0.models.Clickout) => { com.shopr.api.clickouts.api.v0.models.json.jsObjectClickout(obj) } } implicit def jsonReadsClickoutsApiErrorCode: play.api.libs.json.Reads[com.shopr.api.clickouts.api.v0.models.ErrorCode] = { for { code <- (__ \ "code").read[String] localizedStringCode <- (__ \ "localized_string_code").read[String] } yield ErrorCode(code, localizedStringCode) } def jsObjectErrorCode(obj: com.shopr.api.clickouts.api.v0.models.ErrorCode): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "code" -> play.api.libs.json.JsString(obj.code), "localized_string_code" -> play.api.libs.json.JsString(obj.localizedStringCode) ) } implicit def jsonWritesClickoutsApiErrorCode: play.api.libs.json.Writes[ErrorCode] = { (obj: com.shopr.api.clickouts.api.v0.models.ErrorCode) => { com.shopr.api.clickouts.api.v0.models.json.jsObjectErrorCode(obj) } } implicit def jsonReadsClickoutsApiErrorResponse: play.api.libs.json.Reads[com.shopr.api.clickouts.api.v0.models.ErrorResponse] = { for { message <- (__ \ "message").readNullable[String] errorCodes <- (__ \ "error_codes").read[Seq[com.shopr.api.clickouts.api.v0.models.ErrorCode]] fingerprint <- (__ \ "fingerprint").readNullable[String] } yield ErrorResponse(message, errorCodes, fingerprint) } def jsObjectErrorResponse(obj: com.shopr.api.clickouts.api.v0.models.ErrorResponse): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "error_codes" -> play.api.libs.json.Json.toJson(obj.errorCodes) ) ++ (obj.message match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("message" -> play.api.libs.json.JsString(x)) }) ++ (obj.fingerprint match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("fingerprint" -> play.api.libs.json.JsString(x)) }) } implicit def jsonWritesClickoutsApiErrorResponse: play.api.libs.json.Writes[ErrorResponse] = { (obj: com.shopr.api.clickouts.api.v0.models.ErrorResponse) => { com.shopr.api.clickouts.api.v0.models.json.jsObjectErrorResponse(obj) } } implicit def jsonReadsClickoutsApiStatus: play.api.libs.json.Reads[com.shopr.api.clickouts.api.v0.models.Status] = { (__ \ "response").read[String].map { x => Status(response = x) } } def jsObjectStatus(obj: com.shopr.api.clickouts.api.v0.models.Status): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "response" -> play.api.libs.json.JsString(obj.response) ) } implicit def jsonWritesClickoutsApiStatus: play.api.libs.json.Writes[Status] = { (obj: com.shopr.api.clickouts.api.v0.models.Status) => { com.shopr.api.clickouts.api.v0.models.json.jsObjectStatus(obj) } } implicit def jsonReadsClickoutsApiTracking: play.api.libs.json.Reads[com.shopr.api.clickouts.api.v0.models.Tracking] = { for { ipAddress <- (__ \ "ipAddress").read[String] origin <- (__ \ "origin").read[com.shopr.api.clickouts.api.v0.models.ClientOrigin] userAgent <- (__ \ "userAgent").readNullable[String] referrer <- (__ \ "referrer").readNullable[String] } yield Tracking(ipAddress, origin, userAgent, referrer) } def jsObjectTracking(obj: com.shopr.api.clickouts.api.v0.models.Tracking): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "ipAddress" -> play.api.libs.json.JsString(obj.ipAddress), "origin" -> play.api.libs.json.JsString(obj.origin.toString) ) ++ (obj.userAgent match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("userAgent" -> play.api.libs.json.JsString(x)) }) ++ (obj.referrer match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("referrer" -> play.api.libs.json.JsString(x)) }) } implicit def jsonWritesClickoutsApiTracking: play.api.libs.json.Writes[Tracking] = { (obj: com.shopr.api.clickouts.api.v0.models.Tracking) => { com.shopr.api.clickouts.api.v0.models.json.jsObjectTracking(obj) } } } }