api

Type Members

1. case class Account(email: String, allow_tracking: Boolean, id: String, beta: Option[Boolean], created_at: String, last_login: String, updated_at: String, verified: Boolean) extends Product with Serializable

   An account represents an individual signed up to use the Heroku platform.

2. case class AccountFeature(name: String, state: String, description: String, enabled: Boolean, id: String, doc_url: String, created_at: String, updated_at: String) extends Product with Serializable

   An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.

3. trait AccountFeatureRequestJson extends AnyRef

   json serializers related to AccountFeature

4. trait AccountFeatureResponseJson extends AnyRef

   json deserializers related to AccountFeature

5. trait AccountRequestJson extends AnyRef

   json serializers related to Account

6. trait AccountResponseJson extends AnyRef

   json deserializers related to Account

7. case class Addon(name: String, provider_id: String, id: String, created_at: String, updated_at: String, plan: AddonPlan) extends Product with Serializable

   Add-ons represent add-ons that have been provisioned for an app.

8. trait AddonRequestJson extends AnyRef

   json serializers related to Addon

9. trait AddonResponseJson extends AnyRef

   json deserializers related to Addon

10. case class AddonService(created_at: String, id: String, name: String, updated_at: String) extends Product with Serializable

    Add-on services represent add-ons that may be provisioned for apps.

11. trait AddonServiceResponseJson extends AnyRef

    json deserializers related to AddonService

12. trait Api extends AnyRef

13. trait ApiRequestJson extends ConfigVarRequestJson with AccountRequestJson with AccountFeatureRequestJson with AddonRequestJson with AppFeatureRequestJson with AppTransferRequestJson with CollaboratorRequestJson with DomainRequestJson with DynoRequestJson with FormationRequestJson with HerokuAppRequestJson with KeyRequestJson with LogDrainRequestJson with LogSessionRequestJson with OAuthAuthorizationRequestJson with OAuthClientRequestJson with OAuthTokenRequestJson with PlanRequestJson with ReleaseRequestJson with SlugRequestJson with SslEndpointRequestJson

14. trait ApiResponseJson extends ErrorResponseJson with ConfigVarResponseJson with AccountResponseJson with AccountFeatureResponseJson with AddonResponseJson with AddonServiceResponseJson with AppFeatureResponseJson with AppTransferResponseJson with CollaboratorResponseJson with DomainResponseJson with DynoResponseJson with FormationResponseJson with HerokuAppResponseJson with KeyResponseJson with LogDrainResponseJson with LogSessionResponseJson with OAuthAuthorizationResponseJson with OAuthClientResponseJson with OAuthTokenResponseJson with PlanResponseJson with RateLimitResponseJson with RegionResponseJson with ReleaseResponseJson with SlugResponseJson with SslEndpointResponseJson with StackResponseJson

15. case class AppFeature(name: String, state: String, description: String, enabled: Boolean, id: String, doc_url: String, created_at: String, updated_at: String) extends Product with Serializable

    An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.

16. trait AppFeatureRequestJson extends AnyRef

    json serializers related to AppFeature

17. trait AppFeatureResponseJson extends AnyRef

    json deserializers related to AppFeature

18. case class AppTransfer(recipient: AppTransferRecipient, state: String, id: String, app: AppTransferApp, created_at: String, owner: AppTransferOwner, updated_at: String) extends Product with Serializable

    An app transfer represents a two party interaction for transferring ownership of an app.

19. trait AppTransferRequestJson extends AnyRef

    json serializers related to AppTransfer

20. trait AppTransferResponseJson extends AnyRef

    json deserializers related to AppTransfer

21. trait BaseRequest extends AnyRef

22. case class Collaborator(created_at: String, id: String, updated_at: String, user: CollaboratorUser) extends Product with Serializable

    A collaborator represents an account that has been given access to an app on Heroku.

23. trait CollaboratorRequestJson extends AnyRef

    json serializers related to Collaborator

24. trait CollaboratorResponseJson extends AnyRef

    json deserializers related to Collaborator

25. trait ConfigVarRequestJson extends AnyRef

26. trait ConfigVarResponseJson extends AnyRef

27. case class Domain(created_at: String, hostname: String, id: String, updated_at: String) extends Product with Serializable

    Domains define what web routes should be routed to an app on Heroku.

28. trait DomainRequestJson extends AnyRef

    json serializers related to Domain

29. trait DomainResponseJson extends AnyRef

    json deserializers related to Domain

30. case class Dyno(name: String, size: String, state: String, attach_url: Option[String], command: String, id: String, created_at: String, release: DynoRelease, type: String, updated_at: String) extends Product with Serializable

    Dynos encapsulate running processes of an app on Heroku.

31. trait DynoRequestJson extends AnyRef

    json serializers related to Dyno

32. trait DynoResponseJson extends AnyRef

    json deserializers related to Dyno

33. case class ErrorResponse(id: String, message: String) extends Product with Serializable

34. trait ErrorResponseJson extends AnyRef

35. case class Formation(quantity: Int, size: String, command: String, id: String, created_at: String, type: String, updated_at: String) extends Product with Serializable

    The formation of processes that should be maintained for an app.

36. trait FormationRequestJson extends AnyRef

    json serializers related to Formation

37. trait FormationResponseJson extends AnyRef

    json deserializers related to Formation

38. trait FromJson[T] extends AnyRef

39. case class HerokuApp(name: String, repo_size: Option[Int], git_url: String, slug_size: Option[Int], maintenance: Boolean, id: String, released_at: Option[String], web_url: String, stack: HerokuAppStack, region: HerokuAppRegion, created_at: String, owner: HerokuAppOwner, updated_at: String, archived_at: Option[String], buildpack_provided_description: Option[String]) extends Product with Serializable

    An app represents the program that you would like to deploy and run on Heroku.

40. trait HerokuAppRequestJson extends AnyRef

    json serializers related to HerokuApp

41. trait HerokuAppResponseJson extends AnyRef

    json deserializers related to HerokuApp

42. case class Key(fingerprint: String, email: String, public_key: String, id: String, created_at: String, updated_at: String) extends Product with Serializable

    Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.

43. trait KeyRequestJson extends AnyRef

    json serializers related to Key

44. trait KeyResponseJson extends AnyRef

    json deserializers related to Key

45. trait ListRequest[T] extends BaseRequest

46. case class LogDrain(url: String, addon: Option[String], id: String, token: String, created_at: String, updated_at: String) extends Product with Serializable

    [Log drains](https://devcenter.

47. trait LogDrainRequestJson extends AnyRef

    json serializers related to LogDrain

48. trait LogDrainResponseJson extends AnyRef

    json deserializers related to LogDrain

49. case class LogSession(created_at: String, id: String, logplex_url: String, updated_at: String) extends Product with Serializable

    A log session is a reference to the http based log stream for an app.

50. trait LogSessionRequestJson extends AnyRef

    json serializers related to LogSession

51. trait LogSessionResponseJson extends AnyRef

    json deserializers related to LogSession

52. case class OAuthAuthorization(access_token: Option[OAuthAuthorizationAccessToken], scope: List[String], refresh_token: Option[OAuthAuthorizationRefreshToken], id: String, client: Option[OAuthAuthorizationClient], grant: Option[OAuthAuthorizationGrant], created_at: String, updated_at: String) extends Product with Serializable

    OAuth authorizations represent clients that a Heroku user has authorized to automate, customize or extend their usage of the platform.

53. trait OAuthAuthorizationRequestJson extends AnyRef

    json serializers related to OAuthAuthorization

54. trait OAuthAuthorizationResponseJson extends AnyRef

    json deserializers related to OAuthAuthorization

55. case class OAuthClient(secret: String, name: String, redirect_uri: String, ignores_delinquent: Option[Boolean], id: String, created_at: String, updated_at: String) extends Product with Serializable

    OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform.

56. trait OAuthClientRequestJson extends AnyRef

    json serializers related to OAuthClient

57. trait OAuthClientResponseJson extends AnyRef

    json deserializers related to OAuthClient

58. case class OAuthToken(access_token: OAuthTokenAccessToken, refresh_token: OAuthTokenRefreshToken, authorization: OAuthTokenAuthorization, id: String, client: Option[OAuthTokenClient], grant: OAuthTokenGrant, session: OAuthTokenSession, created_at: String, updated_at: String, user: OAuthTokenUser) extends Product with Serializable

    OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform.

59. trait OAuthTokenRequestJson extends AnyRef

    json serializers related to OAuthToken

60. trait OAuthTokenResponseJson extends AnyRef

    json deserializers related to OAuthToken

61. case class PartialResponse[T](list: List[T], nextRange: Option[String]) extends Product with Serializable

62. case class Plan(name: String, state: String, description: String, price: PlanPrice, id: String, default: Boolean, created_at: String, updated_at: String) extends Product with Serializable

    Plans represent different configurations of add-ons that may be added to apps.

63. trait PlanRequestJson extends AnyRef

    json serializers related to Plan

64. trait PlanResponseJson extends AnyRef

    json deserializers related to Plan

65. case class RateLimit(remaining: Int) extends Product with Serializable

    Rate Limit represents the number of request tokens each account holds.

66. trait RateLimitResponseJson extends AnyRef

    json deserializers related to RateLimit

67. case class Region(name: String, description: String, id: String, created_at: String, updated_at: String) extends Product with Serializable

    A region represents a geographic location in which your application may run.

68. trait RegionResponseJson extends AnyRef

    json deserializers related to Region

69. case class Release(description: String, slug: Option[ReleaseSlug], version: Int, id: String, created_at: String, updated_at: String, user: ReleaseUser) extends Product with Serializable

    A release represents a combination of code, config vars and add-ons for an app on Heroku.

70. trait ReleaseRequestJson extends AnyRef

    json serializers related to Release

71. trait ReleaseResponseJson extends AnyRef

    json deserializers related to Release

72. trait Request[O] extends BaseRequest

73. trait RequestWithBody[I, O] extends Request[O]

74. trait RequestWithEmptyResponse extends BaseRequest

75. case class Response[T](status: Int, headers: Map[String, String], body: T) extends Product with Serializable

76. case class SimpleApi(api: Api, apiKey: String) extends Product with Serializable

77. case class Slug(commit: Option[String], process_types: Map[String, String], id: String, created_at: String, updated_at: String, blob: SlugBlob) extends Product with Serializable

    A slug is a snapshot of your application code that is ready to run on the platform.

78. trait SlugRequestJson extends AnyRef

    json serializers related to Slug

79. trait SlugResponseJson extends AnyRef

    json deserializers related to Slug

80. case class SslEndpoint(cname: String, name: String, certificate_chain: String, id: String, created_at: String, updated_at: String) extends Product with Serializable

    [SSL Endpoint](https://devcenter.

81. trait SslEndpointRequestJson extends AnyRef

    json serializers related to SslEndpoint

82. trait SslEndpointResponseJson extends AnyRef

    json deserializers related to SslEndpoint

83. case class Stack(name: String, state: String, id: String, created_at: String, updated_at: String) extends Product with Serializable

    Stacks are the different application execution environments available in the Heroku platform.

84. trait StackResponseJson extends AnyRef

    json deserializers related to Stack

85. case class SyncApi(api: SimpleApi, timeoutSeconds: Int = 10) extends Product with Serializable

86. trait ToJson[T] extends AnyRef