UtilityApiClient

Instance Constructors

new UtilityApiClient(token: String, timeoutDuration: FiniteDuration = 10.seconds)

token
API token
timeoutDuration
Request timeout duration, defaults to 10 seconds.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val basePath: Path
val baseUri: Uri
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def dateTimeToIsoFormat(dateTime: DateTime): String

Convert a DateTime into an ISO 8601 formatted String.
Convert a DateTime into an ISO 8601 formatted String.
dateTime
The DateTime to format.
returns
Formatted String.

Definition Classes
IsoDateTimeConversions
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getAccount(accountUid: String)(implicit format: FormatType = FormatTypes.json): Future[Option[AccountResponse]]

Get an account by account uid.
Get an account by account uid.
accountUid
The unique identifier for the account.
format
The response format.
returns
A Future containing Some account, or None if the account was not found.

See also
https://utilityapi.com/api/docs/api.html#accounts-uid
def getAccounts()(implicit format: FormatType = FormatTypes.json): Future[List[AccountResponse]]

Get all accounts.
Get all accounts.
format
The response format.
returns
A Future containing a list of accounts.

See also
https://utilityapi.com/api/docs/api.html#accounts
def getAccountsByReferralIds(referralIds: List[String])(implicit format: FormatType = FormatTypes.json): Future[List[AccountResponse]]

Get accounts by referral ids.
Get accounts by referral ids.
referralIds
List of referral ids.
format
The response format.
returns
A Future containing a list of accounts.

See also
https://utilityapi.com/api/docs/api.html#accounts
def getBillsByServiceUid(serviceUid: String)(implicit format: FormatType = FormatTypes.json): Future[List[BillResponse]]

Get bills by service uid.
Get bills by service uid.
serviceUid
The unique identifier for the service.
format
The response format.
returns
A Future containing a list of bills.

See also
https://utilityapi.com/api/docs/api.html#bills
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getIntervalsByServiceUid(serviceUid: String, start: Option[DateTime] = None, end: Option[DateTime] = None)(implicit format: FormatType = FormatTypes.json): Future[List[IntervalResponse]]

Get meter intervals by service uid.
Get meter intervals by service uid.
serviceUid
The unique identifier for the service.
format
The response format.
returns
A Future containing a list of meter intervals.

See also
https://utilityapi.com/api/docs/api.html#intervals
def getService(serviceUid: String)(implicit format: FormatType = FormatTypes.json): Future[Option[ServiceResponse]]

Get a service by service uid.
Get a service by service uid.
serviceUid
The unique identifier for the service.
format
The response format.
returns
A Future containing Some service, or None if the service was not found.

See also
https://utilityapi.com/api/docs/api.html#services-uid
def getServices()(implicit format: FormatType = FormatTypes.json): Future[List[ServiceResponse]]

Get all services.
Get all services.
format
The response format.
returns
A Future containing a list of services.

See also
https://utilityapi.com/api/docs/api.html#services
def getServicesByAccountUids(accountUids: List[String])(implicit format: FormatType = FormatTypes.json): Future[List[ServiceResponse]]

Get services by account uids.
Get services by account uids.
accountUids
The unique identifier for the account.
format
The response format.
returns
A Future containing a list of account services.

See also
https://utilityapi.com/api/docs/api.html#services
def getUri(path: Path): Uri

The client URI with the given Path appended to the base Path.
def getUri(segments: Any*): Uri

The client URI with the given String segments appended to the base Path.
def getUri: Uri

The client URI.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isoFormatToDateTime(formatted: String): DateTime

Convert an ISO 8601 formatted String into a DateTime.
Convert an ISO 8601 formatted String into a DateTime.
formatted
The formatted String.
returns
A DateTime.

Definition Classes
IsoDateTimeConversions
def modifyAccount(accountUid: String, request: AccountModifyRequest)(implicit format: FormatType = FormatTypes.json): Future[Option[AccountResponse]]

Modify an account by account uid.
Modify an account by account uid.
accountUid
The unique identifier for the account.
request
The request model.
format
The request/response format.
returns
A Future containing Some account, or None if the account was not found.

See also
https://utilityapi.com/docs#accounts-modify
def modifyService(serviceUid: String, request: ServiceModifyRequest)(implicit format: FormatType = FormatTypes.json): Future[Option[ServiceResponse]]

Modify a service by service uid.
Modify a service by service uid.
serviceUid
The unique identifier for the service.
request
The request model.
format
The request/response format.
returns
A Future containing Some service, or None if the service was not found.

See also
https://utilityapi.com/docs#services-modify
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pipeline[T](request: HttpRequest)(implicit arg0: FromResponseUnmarshaller[T], format: FormatType = FormatTypes.json): Future[T]

Gets a future response for the given request, unmarshalling it to the given type.
Gets a future response for the given request, unmarshalling it to the given type.
T
The type to unmarshal the response to.
request
The HTTP request.
format
Which format to deliver the response in.
returns
A Future containing the unmarshalled response object.

Attributes
protected[com.solarmosaic.client.utilityApi]
implicit def sprayJsonMarshaller[T](implicit writer: RootJsonWriter[T], printer: JsonPrinter): Marshaller[T]

Definition Classes
SprayJsonSupport
implicit def sprayJsonMarshallerConverter[T](writer: RootJsonWriter[T])(implicit printer: JsonPrinter): Marshaller[T]

Definition Classes
SprayJsonSupport
implicit def sprayJsonUnmarshaller[T](implicit arg0: RootJsonReader[T]): Unmarshaller[T]

Definition Classes
SprayJsonSupport
implicit def sprayJsonUnmarshallerConverter[T](reader: RootJsonReader[T]): Unmarshaller[T]

Definition Classes
SprayJsonSupport
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
implicit val system: ActorSystem
implicit val timeout: Timeout
val timeoutDuration: FiniteDuration

Request timeout duration, defaults to 10 seconds.
val token: String

API token
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object UtilityApiClient | package utilityApi

case class UtilityApiClient(token: String, timeoutDuration: FiniteDuration = 10.seconds) extends SprayJsonSupport with IsoDateTimeConversions with Product with Serializable

Instance Constructors

new UtilityApiClient(token: String, timeoutDuration: FiniteDuration = 10.seconds)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val basePath: Path

val baseUri: Uri

def clone(): AnyRef

def dateTimeToIsoFormat(dateTime: DateTime): String

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def getAccount(accountUid: String)(implicit format: FormatType = FormatTypes.json): Future[Option[AccountResponse]]

def getAccounts()(implicit format: FormatType = FormatTypes.json): Future[List[AccountResponse]]

def getAccountsByReferralIds(referralIds: List[String])(implicit format: FormatType = FormatTypes.json): Future[List[AccountResponse]]

def getBillsByServiceUid(serviceUid: String)(implicit format: FormatType = FormatTypes.json): Future[List[BillResponse]]

final def getClass(): Class[_]

def getIntervalsByServiceUid(serviceUid: String, start: Option[DateTime] = None, end: Option[DateTime] = None)(implicit format: FormatType = FormatTypes.json): Future[List[IntervalResponse]]

def getService(serviceUid: String)(implicit format: FormatType = FormatTypes.json): Future[Option[ServiceResponse]]

def getServices()(implicit format: FormatType = FormatTypes.json): Future[List[ServiceResponse]]

def getServicesByAccountUids(accountUids: List[String])(implicit format: FormatType = FormatTypes.json): Future[List[ServiceResponse]]

def getUri(path: Path): Uri

def getUri(segments: Any*): Uri

def getUri: Uri

final def isInstanceOf[T0]: Boolean

def isoFormatToDateTime(formatted: String): DateTime

def modifyAccount(accountUid: String, request: AccountModifyRequest)(implicit format: FormatType = FormatTypes.json): Future[Option[AccountResponse]]

def modifyService(serviceUid: String, request: ServiceModifyRequest)(implicit format: FormatType = FormatTypes.json): Future[Option[ServiceResponse]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pipeline[T](request: HttpRequest)(implicit arg0: FromResponseUnmarshaller[T], format: FormatType = FormatTypes.json): Future[T]

implicit def sprayJsonMarshaller[T](implicit writer: RootJsonWriter[T], printer: JsonPrinter): Marshaller[T]

implicit def sprayJsonMarshallerConverter[T](writer: RootJsonWriter[T])(implicit printer: JsonPrinter): Marshaller[T]

implicit def sprayJsonUnmarshaller[T](implicit arg0: RootJsonReader[T]): Unmarshaller[T]

implicit def sprayJsonUnmarshallerConverter[T](reader: RootJsonReader[T]): Unmarshaller[T]

final def synchronized[T0](arg0: ⇒ T0): T0

implicit val system: ActorSystem

implicit val timeout: Timeout

val timeoutDuration: FiniteDuration

val token: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from IsoDateTimeConversions

Inherited from SprayJsonSupport

Inherited from AnyRef

Inherited from Any

Ungrouped