/** * Generated by API Builder - https://www.apibuilder.io * Service version: 1.1.0 * User agent: apibuilder app.apibuilder.io/hbc/api-product-recommendations-lat/1.1.0/play_2_2_client */ package com.hbc.api.product.recommendations.lat.v1.models { /** * Product price in USD * * @param was formatted price in USD * @param now formatted price in USD * @param onSale true if now price is < was price. Used to */ final case class Price( was: String, now: String, onSale: Boolean = false ) /** * @param rating customer review's rating * @param numReviews number of customers that reviewed the product */ final case class Recommendation( productId: String, productName: String, productUrl: String, productImageUrl: String, brandName: String, price: com.hbc.api.product.recommendations.lat.v1.models.Price, rating: _root_.scala.Option[Double] = None, numReviews: _root_.scala.Option[Long] = None ) final case class SimilarProductRecommendation( recommendations: Seq[com.hbc.api.product.recommendations.lat.v1.models.Recommendation] ) sealed trait SimilarProductContext extends _root_.scala.Product with _root_.scala.Serializable object SimilarProductContext { /** * PDP page. (Strict category match) */ case object Pdp extends SimilarProductContext { override def toString = "pdp" } /** * 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 SimilarProductContext /** * 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[SimilarProductContext] = scala.List(Pdp) private val byName: Map[String, SimilarProductContext] = all.map(x => x.toString.toLowerCase -> x).toMap def apply(value: String): SimilarProductContext = fromString(value).getOrElse(UNDEFINED(value)) def fromString(value: String): _root_.scala.Option[SimilarProductContext] = byName.get(value.toLowerCase) } } package com.hbc.api.product.recommendations.lat.v1.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.hbc.api.product.recommendations.lat.v1.models.json._ private[v1] implicit val jsonReadsUUID: play.api.libs.json.Reads[_root_.java.util.UUID] = __.read[String].map { str => _root_.java.util.UUID.fromString(str) } private[v1] 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[v1] 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[v1] 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[v1] 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[v1] 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 jsonReadsApiProductRecommendationsLatSimilarProductContext: play.api.libs.json.Reads[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext] = new play.api.libs.json.Reads[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext] { def reads(js: play.api.libs.json.JsValue): play.api.libs.json.JsResult[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext] = { js match { case v: play.api.libs.json.JsString => play.api.libs.json.JsSuccess(com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext(v.value)) case _ => { (js \ "value").validate[String] match { case play.api.libs.json.JsSuccess(v, _) => play.api.libs.json.JsSuccess(com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext(v)) case _: play.api.libs.json.JsError => (js \ "similarProductContext").validate[String] match { case play.api.libs.json.JsSuccess(v, _) => play.api.libs.json.JsSuccess(com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext(v)) case err: play.api.libs.json.JsError => err } } } } } } def jsonWritesApiProductRecommendationsLatSimilarProductContext(obj: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext) = { play.api.libs.json.JsString(obj.toString) } def jsObjectSimilarProductContext(obj: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext) = { play.api.libs.json.Json.obj("value" -> play.api.libs.json.JsString(obj.toString)) } implicit def jsonWritesApiProductRecommendationsLatSimilarProductContext: play.api.libs.json.Writes[SimilarProductContext] = { (obj: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext) => { com.hbc.api.product.recommendations.lat.v1.models.json.jsonWritesApiProductRecommendationsLatSimilarProductContext(obj) } } implicit def jsonReadsApiProductRecommendationsLatPrice: play.api.libs.json.Reads[com.hbc.api.product.recommendations.lat.v1.models.Price] = { for { was <- (__ \ "was").read[String] now <- (__ \ "now").read[String] onSale <- (__ \ "onSale").read[Boolean] } yield Price(was, now, onSale) } def jsObjectPrice(obj: com.hbc.api.product.recommendations.lat.v1.models.Price): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "was" -> play.api.libs.json.JsString(obj.was), "now" -> play.api.libs.json.JsString(obj.now), "onSale" -> play.api.libs.json.JsBoolean(obj.onSale) ) } implicit def jsonWritesApiProductRecommendationsLatPrice: play.api.libs.json.Writes[Price] = { (obj: com.hbc.api.product.recommendations.lat.v1.models.Price) => { com.hbc.api.product.recommendations.lat.v1.models.json.jsObjectPrice(obj) } } implicit def jsonReadsApiProductRecommendationsLatRecommendation: play.api.libs.json.Reads[com.hbc.api.product.recommendations.lat.v1.models.Recommendation] = { for { productId <- (__ \ "productId").read[String] productName <- (__ \ "productName").read[String] productUrl <- (__ \ "productUrl").read[String] productImageUrl <- (__ \ "productImageUrl").read[String] brandName <- (__ \ "brandName").read[String] price <- (__ \ "price").read[com.hbc.api.product.recommendations.lat.v1.models.Price] rating <- (__ \ "rating").readNullable[Double] numReviews <- (__ \ "numReviews").readNullable[Long] } yield Recommendation(productId, productName, productUrl, productImageUrl, brandName, price, rating, numReviews) } def jsObjectRecommendation(obj: com.hbc.api.product.recommendations.lat.v1.models.Recommendation): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "productId" -> play.api.libs.json.JsString(obj.productId), "productName" -> play.api.libs.json.JsString(obj.productName), "productUrl" -> play.api.libs.json.JsString(obj.productUrl), "productImageUrl" -> play.api.libs.json.JsString(obj.productImageUrl), "brandName" -> play.api.libs.json.JsString(obj.brandName), "price" -> com.hbc.api.product.recommendations.lat.v1.models.json.jsObjectPrice(obj.price) ) ++ (obj.rating match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("rating" -> play.api.libs.json.JsNumber(x)) }) ++ (obj.numReviews match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("numReviews" -> play.api.libs.json.JsNumber(x)) }) } implicit def jsonWritesApiProductRecommendationsLatRecommendation: play.api.libs.json.Writes[Recommendation] = { (obj: com.hbc.api.product.recommendations.lat.v1.models.Recommendation) => { com.hbc.api.product.recommendations.lat.v1.models.json.jsObjectRecommendation(obj) } } implicit def jsonReadsApiProductRecommendationsLatSimilarProductRecommendation: play.api.libs.json.Reads[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductRecommendation] = { (__ \ "recommendations").read[Seq[com.hbc.api.product.recommendations.lat.v1.models.Recommendation]].map { x => SimilarProductRecommendation(recommendations = x) } } def jsObjectSimilarProductRecommendation(obj: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductRecommendation): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "recommendations" -> play.api.libs.json.Json.toJson(obj.recommendations) ) } implicit def jsonWritesApiProductRecommendationsLatSimilarProductRecommendation: play.api.libs.json.Writes[SimilarProductRecommendation] = { (obj: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductRecommendation) => { com.hbc.api.product.recommendations.lat.v1.models.json.jsObjectSimilarProductRecommendation(obj) } } } } package com.hbc.api.product.recommendations.lat.v1 { 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 com.hbc.api.product.recommendations.lat.v1.models._ val similarProductContextConverter: ApibuilderTypeConverter[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext] = new ApibuilderTypeConverter[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext] { override def convert(value: String): com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext = com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext(value) override def convert(value: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext): String = value.toString override def example: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext = com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext.Pdp override def validValues: Seq[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext] = com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext.all } implicit def pathBindableSimilarProductContext(implicit stringBinder: QueryStringBindable[String]): PathBindable[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext] = ApibuilderPathBindable(similarProductContextConverter) implicit def queryStringBindableSimilarProductContext(implicit stringBinder: QueryStringBindable[String]): QueryStringBindable[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext] = ApibuilderQueryStringBindable(similarProductContextConverter) } 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 com.hbc.api.product.recommendations.lat.v1 { object Constants { val BaseUrl = "https://m.lordandtaylor.com/api-product-suggestions" val Namespace = "com.hbc.api.product.recommendations.lat.v1" val UserAgent = "apibuilder app.apibuilder.io/hbc/api-product-recommendations-lat/1.1.0/play_2_2_client" val Version = "1.1.0" val VersionMajor = 1 } class Client( val baseUrl: String = "https://m.lordandtaylor.com/api-product-suggestions", auth: scala.Option[com.hbc.api.product.recommendations.lat.v1.Authorization] = None, defaultHeaders: Seq[(String, String)] = Nil ) extends interfaces.Client { import com.hbc.api.product.recommendations.lat.v1.models.json._ private val logger = play.api.Logger("com.hbc.api.product.recommendations.lat.v1.Client") logger.info(s"Initializing com.hbc.api.product.recommendations.lat.v1.Client for url $baseUrl") def similarProductRecommendations: SimilarProductRecommendations = SimilarProductRecommendations object SimilarProductRecommendations extends SimilarProductRecommendations { override def getByContextAndProductId( context: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext = com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext.Pdp, productId: String, color: _root_.scala.Option[String] = None, limit: Int = 10, abTestName: _root_.scala.Option[String] = None, abTestVariant: _root_.scala.Option[String] = None, referer: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductRecommendation] = { val queryParameters = Seq( color.map("color" -> _), Some("limit" -> limit.toString), abTestName.map("abTestName" -> _), abTestVariant.map("abTestVariant" -> _) ).flatten val headerParameters = Seq( Some("Referer" -> referer) ).flatten _executeRequest("GET", s"/similarProductRecommendations/${play.utils.UriEncoding.encodePathSegment(context.toString, "UTF-8")}/${play.utils.UriEncoding.encodePathSegment(productId, "UTF-8")}", queryParameters = queryParameters, requestHeaders = (requestHeaders ++ headerParameters)).map { case r if r.status == 200 => _root_.com.hbc.api.product.recommendations.lat.v1.Client.parseJson("com.hbc.api.product.recommendations.lat.v1.models.SimilarProductRecommendation", r, _.validate[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductRecommendation]) case r => throw com.hbc.api.product.recommendations.lat.v1.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200", requestUri = Some(r.ahcResponse.getUri)) } } } def _requestHolder(path: String): play.api.libs.ws.WS.WSRequestHolder = { import play.api.Play.current val holder = play.api.libs.ws.WS.url(baseUrl + path).withHeaders( "User-Agent" -> Constants.UserAgent, "X-Apidoc-Version" -> Constants.Version, "X-Apidoc-Version-Major" -> Constants.VersionMajor.toString ).withHeaders(defaultHeaders: _*) auth.fold(holder) { case Authorization.Basic(username, password) => { holder.withAuth(username, password.getOrElse(""), com.ning.http.client.Realm.AuthScheme.BASIC) } } } def _logRequest(method: String, req: play.api.libs.ws.WS.WSRequestHolder): play.api.libs.ws.WS.WSRequestHolder = { 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.Response] = { method.toUpperCase match { case "GET" => { _logRequest("GET", _requestHolder(path).withHeaders(requestHeaders: _*).withQueryString(queryParameters: _*)).get() } case "POST" => { _logRequest("POST", _requestHolder(path).withHeaders(_withJsonContentType(requestHeaders): _*).withQueryString(queryParameters: _*)).post(body.getOrElse(play.api.libs.json.Json.obj())) } case "PUT" => { _logRequest("PUT", _requestHolder(path).withHeaders(_withJsonContentType(requestHeaders): _*).withQueryString(queryParameters: _*)).put(body.getOrElse(play.api.libs.json.Json.obj())) } case "PATCH" => { sys.error("PATCH method is not supported in Play Framework Version 2.2.x") } case "DELETE" => { _logRequest("DELETE", _requestHolder(path).withHeaders(requestHeaders: _*).withQueryString(queryParameters: _*)).delete() } case "HEAD" => { _logRequest("HEAD", _requestHolder(path).withHeaders(requestHeaders: _*).withQueryString(queryParameters: _*)).head() } case "OPTIONS" => { _logRequest("OPTIONS", _requestHolder(path).withHeaders(requestHeaders: _*).withQueryString(queryParameters: _*)).options() } case _ => { _logRequest(method, _requestHolder(path).withHeaders(requestHeaders: _*).withQueryString(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.Response, 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 com.hbc.api.product.recommendations.lat.v1.errors.FailedRequest(r.status, s"Invalid json for class[" + className + "]: " + errors.mkString(" "), requestUri = Some(r.ahcResponse.getUri)) } } } } 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 similarProductRecommendations: com.hbc.api.product.recommendations.lat.v1.SimilarProductRecommendations } } trait SimilarProductRecommendations { /** * Gets similar products recommendations inferring the org from the domain referrer * * @param context Context in which to show similar products, eg: PDP * @param productId Product code for which we want to return similar products * @param color plain text color * @param limit Limit on number of recommendations to be returned * @param referer The service will use the content of this header to infer the org * @param abTestName Name of the abTest being run (if any) * @param abTestVariant Variant in the abTest (if any) */ def getByContextAndProductId( context: com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext = com.hbc.api.product.recommendations.lat.v1.models.SimilarProductContext.Pdp, productId: String, color: _root_.scala.Option[String] = None, limit: Int = 10, abTestName: _root_.scala.Option[String] = None, abTestVariant: _root_.scala.Option[String] = None, referer: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[com.hbc.api.product.recommendations.lat.v1.models.SimilarProductRecommendation] } package errors { final case class FailedRequest(responseCode: Int, message: String, requestUri: Option[_root_.java.net.URI] = None) extends _root_.java.lang.Exception(s"HTTP $responseCode: $message") } }