/** * Generated by API Builder - https://www.apibuilder.io * Service version: 2.0.0-dev * User agent: apibuilder app.apibuilder.io/hbc/svc-sundial/2.0.0-dev/play_2_6 */ package com.hbc.svc.sundial.v2 { object Constants { val Namespace = "com.hbc.svc.sundial.v2" val UserAgent = "apibuilder app.apibuilder.io/hbc/svc-sundial/2.0.0-dev/play_2_6" val Version = "2.0.0-dev" val VersionMajor = 2 } class Client( ws: play.api.libs.ws.WSClient, val baseUrl: String, auth: scala.Option[com.hbc.svc.sundial.v2.Authorization] = None, defaultHeaders: Seq[(String, String)] = Nil ) extends interfaces.Client { import com.hbc.svc.sundial.v2.models.json._ private val logger = play.api.Logger("com.hbc.svc.sundial.v2.Client") logger.info(s"Initializing com.hbc.svc.sundial.v2.Client for url $baseUrl") def healthchecks: Healthchecks = Healthchecks def processDefinitions: ProcessDefinitions = ProcessDefinitions def processes: Processes = Processes def tasks: Tasks = Tasks object Healthchecks extends Healthchecks { override def getMetrics( requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[String] = { _executeRequest("GET", s"/_internal_/metrics", requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.com.hbc.svc.sundial.v2.Client.parseJson("String", r, _.validate[String]) case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } } object ProcessDefinitions extends ProcessDefinitions { override def get( requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[Seq[com.hbc.svc.sundial.v2.models.ProcessDefinition]] = { _executeRequest("GET", s"/api/process_definitions/", requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.com.hbc.svc.sundial.v2.Client.parseJson( "Seq[com.hbc.svc.sundial.v2.models.ProcessDefinition]", r, _.validate[Seq[com.hbc.svc.sundial.v2.models.ProcessDefinition]] ) case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } override def getByProcessDefinitionName( processDefinitionName: String, requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[com.hbc.svc.sundial.v2.models.ProcessDefinition] = { _executeRequest( "GET", s"/api/process_definitions/${play.utils.UriEncoding.encodePathSegment(processDefinitionName, "UTF-8")}", requestHeaders = requestHeaders ).map { case r if r.status == 200 => _root_.com.hbc.svc.sundial.v2.Client.parseJson( "com.hbc.svc.sundial.v2.models.ProcessDefinition", r, _.validate[com.hbc.svc.sundial.v2.models.ProcessDefinition] ) case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } override def putByProcessDefinitionName( processDefinitionName: String, processDefinition: com.hbc.svc.sundial.v2.models.ProcessDefinition, requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[com.hbc.svc.sundial.v2.models.ProcessDefinition] = { val payload = play.api.libs.json.Json.toJson(processDefinition) _executeRequest( "PUT", s"/api/process_definitions/${play.utils.UriEncoding.encodePathSegment(processDefinitionName, "UTF-8")}", body = Some(payload), requestHeaders = requestHeaders ).map { case r if r.status == 200 => _root_.com.hbc.svc.sundial.v2.Client.parseJson( "com.hbc.svc.sundial.v2.models.ProcessDefinition", r, _.validate[com.hbc.svc.sundial.v2.models.ProcessDefinition] ) case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } override def deleteByProcessDefinitionName( processDefinitionName: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { _executeRequest( "DELETE", s"/api/process_definitions/${play.utils.UriEncoding.encodePathSegment(processDefinitionName, "UTF-8")}", requestHeaders = requestHeaders ).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } override def postTriggerByProcessDefinitionName( processDefinitionName: String, taskDefinitionName: _root_.scala.Option[String] = None, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { val queryParameters = Seq( taskDefinitionName.map("task_definition_name" -> _) ).flatten _executeRequest( "POST", s"/api/process_definitions/${play.utils.UriEncoding.encodePathSegment(processDefinitionName, "UTF-8")}/trigger", queryParameters = queryParameters, requestHeaders = requestHeaders ).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } override def postPauseByProcessDefinitionName( processDefinitionName: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { _executeRequest( "POST", s"/api/process_definitions/${play.utils.UriEncoding.encodePathSegment(processDefinitionName, "UTF-8")}/pause", requestHeaders = requestHeaders ).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } override def postResumeByProcessDefinitionName( processDefinitionName: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { _executeRequest( "POST", s"/api/process_definitions/${play.utils.UriEncoding.encodePathSegment(processDefinitionName, "UTF-8")}/resume", requestHeaders = requestHeaders ).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } } object Processes extends Processes { override def get( processDefinitionName: _root_.scala.Option[String] = None, startTime: _root_.scala.Option[_root_.java.time.OffsetDateTime] = None, endTime: _root_.scala.Option[_root_.java.time.OffsetDateTime] = None, maxRecords: _root_.scala.Option[Int] = None, allowedStatuses: Seq[com.hbc.svc.sundial.v2.models.ProcessStatus], requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[Seq[com.hbc.svc.sundial.v2.models.Process]] = { val queryParameters = Seq( processDefinitionName.map("process_definition_name" -> _), startTime.map("start_time" -> _.toString), endTime.map("end_time" -> _.toString), maxRecords.map("max_records" -> _.toString) ).flatten ++ allowedStatuses.map("allowed_statuses" -> _.toString) _executeRequest("GET", s"/api/processes/", queryParameters = queryParameters, requestHeaders = requestHeaders) .map { case r if r.status == 200 => _root_.com.hbc.svc.sundial.v2.Client.parseJson( "Seq[com.hbc.svc.sundial.v2.models.Process]", r, _.validate[Seq[com.hbc.svc.sundial.v2.models.Process]] ) case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } override def getByProcessId( processId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[com.hbc.svc.sundial.v2.models.Process] = { _executeRequest("GET", s"/api/processes/${processId}", requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.com.hbc.svc.sundial.v2.Client .parseJson("com.hbc.svc.sundial.v2.models.Process", r, _.validate[com.hbc.svc.sundial.v2.models.Process]) case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } override def postRetryByProcessId( processId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { _executeRequest("POST", s"/api/processes/${processId}/retry", requestHeaders = requestHeaders).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } override def postKillByProcessId( processId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { _executeRequest("POST", s"/api/processes/${processId}/kill", requestHeaders = requestHeaders).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } } object Tasks extends Tasks { override def get( processDefinitionName: String, taskDefinitionName: String, allowedStatuses: Seq[com.hbc.svc.sundial.v2.models.TaskStatus], startTime: _root_.scala.Option[_root_.java.time.OffsetDateTime] = None, endTime: _root_.scala.Option[_root_.java.time.OffsetDateTime] = None, limit: _root_.scala.Option[Int] = None, requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[Seq[com.hbc.svc.sundial.v2.models.Task]] = { val queryParameters = Seq( Some("process_definition_name" -> processDefinitionName), Some("task_definition_name" -> taskDefinitionName), startTime.map("start_time" -> _.toString), endTime.map("end_time" -> _.toString), limit.map("limit" -> _.toString) ).flatten ++ allowedStatuses.map("allowed_statuses" -> _.toString) _executeRequest("GET", s"/api/tasks/", queryParameters = queryParameters, requestHeaders = requestHeaders).map { case r if r.status == 200 => _root_.com.hbc.svc.sundial.v2.Client.parseJson( "Seq[com.hbc.svc.sundial.v2.models.Task]", r, _.validate[Seq[com.hbc.svc.sundial.v2.models.Task]] ) case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 200") } } override def postLogEntriesByTaskId( taskId: _root_.java.util.UUID, logEntries: Seq[com.hbc.svc.sundial.v2.models.LogEntry], requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { val payload = play.api.libs.json.Json.toJson(logEntries) _executeRequest( "POST", s"/api/tasks/${taskId}/log_entries", body = Some(payload), requestHeaders = requestHeaders ).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } override def postMetadataByTaskId( taskId: _root_.java.util.UUID, metadataEntries: Seq[com.hbc.svc.sundial.v2.models.MetadataEntry], requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { val payload = play.api.libs.json.Json.toJson(metadataEntries) _executeRequest("POST", s"/api/tasks/${taskId}/metadata", body = Some(payload), requestHeaders = requestHeaders) .map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } override def postSucceedByTaskId( taskId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { _executeRequest("POST", s"/api/tasks/${taskId}/succeed", requestHeaders = requestHeaders).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } override def postFailByTaskId( taskId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] = { _executeRequest("POST", s"/api/tasks/${taskId}/fail", requestHeaders = requestHeaders).map { case r if r.status == 204 => () case r => throw com.hbc.svc.sundial.v2.errors .FailedRequest(r.status, s"Unsupported response code[${r.status}]. Expected: 204") } } } 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 com.hbc.svc.sundial.v2.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 healthchecks: com.hbc.svc.sundial.v2.Healthchecks def processDefinitions: com.hbc.svc.sundial.v2.ProcessDefinitions def processes: com.hbc.svc.sundial.v2.Processes def tasks: com.hbc.svc.sundial.v2.Tasks } } trait Healthchecks { def getMetrics( requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[String] } trait ProcessDefinitions { /** * Get all currently registered process definitions */ def get( requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[Seq[com.hbc.svc.sundial.v2.models.ProcessDefinition]] /** * Get a registered process definition */ def getByProcessDefinitionName( processDefinitionName: String, requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[com.hbc.svc.sundial.v2.models.ProcessDefinition] /** * Updates or creates a process definition */ def putByProcessDefinitionName( processDefinitionName: String, processDefinition: com.hbc.svc.sundial.v2.models.ProcessDefinition, requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[com.hbc.svc.sundial.v2.models.ProcessDefinition] /** * Deletes a registered process definition */ def deleteByProcessDefinitionName( processDefinitionName: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] /** * Triggers a new instance of the process */ def postTriggerByProcessDefinitionName( processDefinitionName: String, taskDefinitionName: _root_.scala.Option[String] = None, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] /** * Pause the process schedule */ def postPauseByProcessDefinitionName( processDefinitionName: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] /** * Resume the process schedule */ def postResumeByProcessDefinitionName( processDefinitionName: String, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] } trait Processes { /** * Retrieves a list of process runs based on search parameters. */ def get( processDefinitionName: _root_.scala.Option[String] = None, startTime: _root_.scala.Option[_root_.java.time.OffsetDateTime] = None, endTime: _root_.scala.Option[_root_.java.time.OffsetDateTime] = None, maxRecords: _root_.scala.Option[Int] = None, allowedStatuses: Seq[com.hbc.svc.sundial.v2.models.ProcessStatus], requestHeaders: Seq[(String, String)] = Nil )( implicit ec: scala.concurrent.ExecutionContext ): scala.concurrent.Future[Seq[com.hbc.svc.sundial.v2.models.Process]] /** * Retrieves a process run */ def getByProcessId( processId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[com.hbc.svc.sundial.v2.models.Process] /** * Retries a failed process run by restarting failed tasks; tasks will be given a * single additional attempt */ def postRetryByProcessId( processId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] /** * Terminates an active process */ def postKillByProcessId( processId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] } trait Tasks { /** * Retrieves the most recent tasks meeting the given criteria */ def get( processDefinitionName: String, taskDefinitionName: String, allowedStatuses: Seq[com.hbc.svc.sundial.v2.models.TaskStatus], startTime: _root_.scala.Option[_root_.java.time.OffsetDateTime] = None, endTime: _root_.scala.Option[_root_.java.time.OffsetDateTime] = None, limit: _root_.scala.Option[Int] = None, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Seq[com.hbc.svc.sundial.v2.models.Task]] /** * Appends log entries for a task; intended for use within the task executable */ def postLogEntriesByTaskId( taskId: _root_.java.util.UUID, logEntries: Seq[com.hbc.svc.sundial.v2.models.LogEntry], requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] /** * Appends metadata entries for a task; intended for use within the task executable */ def postMetadataByTaskId( taskId: _root_.java.util.UUID, metadataEntries: Seq[com.hbc.svc.sundial.v2.models.MetadataEntry], requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] /** * Marks the task as having succeeded */ def postSucceedByTaskId( taskId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] /** * Marks the task as having failed */ def postFailByTaskId( taskId: _root_.java.util.UUID, requestHeaders: Seq[(String, String)] = Nil )(implicit ec: scala.concurrent.ExecutionContext): scala.concurrent.Future[Unit] } 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") } }