/** * Generated by API Builder - https://www.apibuilder.io * Service version: 1.0.0-dev * User agent: apibuilder app.apibuilder.io/helicalmoment/zola-takehome/1.0.0-dev/play_2_8_client */ package org.helicalmoment.zola.takehome.v1.models { /** * An invoice * * @param id Unique identifier for an invoice * @param invoiceNumber The invoice number associated with the invoice * @param poNumber The purchase number associated with the invoice * @param dueDate When invoice payment is due * @param amountCents Total amount of invoice in US cents * @param createdAt Invoice creation timestamp */ final case class Invoice( id: _root_.scala.Option[Int] = None, invoiceNumber: String, poNumber: String, dueDate: _root_.org.joda.time.LocalDate, amountCents: Long, createdAt: _root_.scala.Option[_root_.org.joda.time.DateTime] = None ) } package org.helicalmoment.zola.takehome.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 org.helicalmoment.zola.takehome.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 def jsonReadsZolaTakehomeInvoice: play.api.libs.json.Reads[org.helicalmoment.zola.takehome.v1.models.Invoice] = { for { id <- (__ \ "id").readNullable[Int] invoiceNumber <- (__ \ "invoice_number").read[String] poNumber <- (__ \ "po_number").read[String] dueDate <- (__ \ "due_date").read[_root_.org.joda.time.LocalDate] amountCents <- (__ \ "amount_cents").read[Long] createdAt <- (__ \ "created_at").readNullable[_root_.org.joda.time.DateTime] } yield Invoice(id, invoiceNumber, poNumber, dueDate, amountCents, createdAt) } def jsObjectInvoice(obj: org.helicalmoment.zola.takehome.v1.models.Invoice): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "invoice_number" -> play.api.libs.json.JsString(obj.invoiceNumber), "po_number" -> play.api.libs.json.JsString(obj.poNumber), "due_date" -> play.api.libs.json.JsString(_root_.org.joda.time.format.ISODateTimeFormat.date.print(obj.dueDate)), "amount_cents" -> play.api.libs.json.JsNumber(obj.amountCents) ) ++ (obj.id match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("id" -> play.api.libs.json.JsNumber(x)) }) ++ (obj.createdAt match { case None => play.api.libs.json.Json.obj() case Some(x) => play.api.libs.json.Json.obj("created_at" -> play.api.libs.json.JsString(_root_.org.joda.time.format.ISODateTimeFormat.dateTime.print(x))) }) } implicit def jsonWritesZolaTakehomeInvoice: play.api.libs.json.Writes[Invoice] = { (obj: org.helicalmoment.zola.takehome.v1.models.Invoice) => { org.helicalmoment.zola.takehome.v1.models.json.jsObjectInvoice(obj) } } } } package org.helicalmoment.zola.takehome.v1 { object Bindables { import play.api.mvc.{PathBindable, QueryStringBindable} // import models directly for backwards compatibility with prior versions of the generator import Core._ 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) } 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 org.helicalmoment.zola.takehome.v1 { object Constants { val BaseUrl = "localhost" val Namespace = "org.helicalmoment.zola.takehome.v1" val UserAgent = "apibuilder app.apibuilder.io/helicalmoment/zola-takehome/1.0.0-dev/play_2_8_client" val Version = "1.0.0-dev" val VersionMajor = 1 } class Client( ws: play.api.libs.ws.WSClient, val baseUrl: String = "localhost", auth: scala.Option[org.helicalmoment.zola.takehome.v1.Authorization] = None, defaultHeaders: Seq[(String, String)] = Nil ) extends interfaces.Client { import org.helicalmoment.zola.takehome.v1.models.json._ private val logger = play.api.Logger("org.helicalmoment.zola.takehome.v1.Client") logger.info(s"Initializing org.helicalmoment.zola.takehome.v1.Client for url $baseUrl") def invoices: Invoices = Invoices object Invoices extends Invoices { override def put( invoice: org.helicalmoment.zola.takehome.v1.models.Invoice, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[org.helicalmoment.zola.takehome.v1.models.Invoice] = { val payload = play.api.libs.json.Json.toJson(invoice) _executeRequest("PUT", s"/v1/invoices", body = Some(payload), requestHeaders = requestHeaders).map { case r if r.status == 201 => _root_.org.helicalmoment.zola.takehome.v1.Client.parseJson("org.helicalmoment.zola.takehome.v1.models.Invoice", r, _.validate[org.helicalmoment.zola.takehome.v1.models.Invoice]) case r => throw org.helicalmoment.zola.takehome.v1.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 201") } } override def get( invoiceNumber: _root_.scala.Option[String] = None, poNumber: _root_.scala.Option[String] = None, limit: _root_.scala.Option[Int] = None, offset: _root_.scala.Option[Int] = None, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Seq[org.helicalmoment.zola.takehome.v1.models.Invoice]] = { val queryParameters = Seq( invoiceNumber.map("invoice_number" -> _), poNumber.map("po_number" -> _), limit.map("limit" -> _.toString), offset.map("offset" -> _.toString) ).flatten _executeRequest("GET", s"/v1/invoices", queryParameters = queryParameters, requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.org.helicalmoment.zola.takehome.v1.Client.parseJson("Seq[org.helicalmoment.zola.takehome.v1.models.Invoice]", r, _.validate[Seq[org.helicalmoment.zola.takehome.v1.models.Invoice]]) case r => throw org.helicalmoment.zola.takehome.v1.errors.FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } } 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 org.helicalmoment.zola.takehome.v1.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 invoices: org.helicalmoment.zola.takehome.v1.Invoices } } trait Invoices { /** * Insert an invoice */ def put( invoice: org.helicalmoment.zola.takehome.v1.models.Invoice, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[org.helicalmoment.zola.takehome.v1.models.Invoice] /** * Find an invoice by invoice_number or po_number. If neither is provided, returns * all invoices. * * @param invoiceNumber An invoice number to search for. * @param poNumber An purchase order number to search for. * @param limit How many records to return. Defaults to 50 if not provided or not in the range 0 * < limit <= 50. * @param offset Pagination offset; e.g., to retrieve the second page of invoices with a limit of * 50, set to 51. If not provided, defaults to 0. */ def get( invoiceNumber: _root_.scala.Option[String] = None, poNumber: _root_.scala.Option[String] = None, limit: _root_.scala.Option[Int] = None, offset: _root_.scala.Option[Int] = None, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Seq[org.helicalmoment.zola.takehome.v1.models.Invoice]] } 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") } }