Sensibill Rest API/com.getsensibill.rest.network/DefaultEnvironment

DefaultEnvironment

enum DefaultEnvironment : Enum<DefaultEnvironment> , SBEnvironment

DefaultEnvironment.kt

Enum that defines a Sensibill Backend(API) Environment. Contains the backend host name

Entries

The Production environment (receipts.getsensibill.com)

RECEIPTS_SANDBOX

RECEIPTS_SANDBOX

The non-production Sandbox environment (receipts-sandbox.sensibill.io)

The non-production Beta environment (beta.getsensibill.com)

~~BETA_SANDBOX~~

~~BETA_STAGING~~

RECEIPTS_STAGING

~~RECEIPTS_STAGING~~

Properties

open override val hasHttps: Boolean = true

If the Sensibill environment is using https (true) or http (false)

open override val hostName: String

the host name of the Sensibill Environment. eg. my.environment.com

val name: String

val ordinal: Int

open override val v1BaseUrl: String

The base url of the API v1 endpoints. By default set this to result of defaultV1BaseUrl

open override val v2BaseUrl: String

The base url of the API v2 endpoints. By default set this to result of defaultV2BaseUrl

Functions

defaultV1BaseUrl

fun SBEnvironment.defaultV1BaseUrl(): String

The default v1 Base Url

defaultV2BaseUrl

fun SBEnvironment.defaultV2BaseUrl(): String

The default v2 Base Url

fun valueOf(value: String): DefaultEnvironment

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<DefaultEnvironment>

Returns an array containing the constants of this enum type, in the order they're declared.