bloombox / bloombox.client / Bloombox / APIEnvironment

APIEnvironment

enum class APIEnvironment (source)

Describes available API environments. In some cases, you may want to test systems against bleeding-edge or beta versions of Bloombox services. Use 'STAGING' to test against the beta environment. 'SANDBOX' is reserved for internal use only and refuses non-internal traffic. Note that this value describes the data namespace in use for a given API client, not the systems the traffic is sent to.

Enum Values

PRODUCTION

Production API namespace. Default.

STAGING

Staging or beta API namespace.

SANDBOX

Sandbox namespace, for internal use only.

Properties

code

val code: String

Fetch the region code for a given region. This is basically the name of the environment, but in lowercase, except for one exception: "production" has the code, "prod."