Orb Kotlin API Library

The Orb Kotlin SDK provides convenient access to the Orb REST API from applications written in Kotlin.

The Orb Kotlin SDK is similar to the Orb Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of Optional, Sequence instead of Stream, and suspend functions instead of CompletableFuture.

The REST API documentation can be found on docs.withorb.com.

Installation

Gradle

implementation("com.withorb.api:orb-kotlin:0.1.0-alpha.43")

Maven

<dependency>
  <groupId>com.withorb.api</groupId>
  <artifactId>orb-kotlin</artifactId>
  <version>0.1.0-alpha.43</version>
</dependency>

Requirements

This library requires Java 8 or later.

Usage

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient
import com.withorb.api.models.Customer
import com.withorb.api.models.CustomerCreateParams

// Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
val client: OrbClient = OrbOkHttpClient.fromEnv()

val params: CustomerCreateParams = CustomerCreateParams.builder()
    .email("[email protected]")
    .name("My Customer")
    .build()
val customer: Customer = client.customers().create(params)

Client configuration

Configure the client using environment variables:

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient

// Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
val client: OrbClient = OrbOkHttpClient.fromEnv()

Or manually:

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient

val client: OrbClient = OrbOkHttpClient.builder()
    .apiKey("My API Key")
    .build()

Or using a combination of the two approaches:

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient

val client: OrbClient = OrbOkHttpClient.builder()
    // Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
    .fromEnv()
    .apiKey("My API Key")
    .build()

See this table for the available options:

Setter	Environment variable	Required	Default value
apiKey	ORB_API_KEY	true	-
webhookSecret	ORB_WEBHOOK_SECRET	false	-

Tip

Don't create more than one client in the same application. Each client has a connection pool and thread pools, which are more efficient to share between requests.

Requests and responses

To send a request to the Orb API, build an instance of some Params class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.

For example, client.customers().create(...) should be called with an instance of CustomerCreateParams, and it will return an instance of Customer.

Immutability

Each class in the SDK has an associated builder or factory method for constructing it.

Each class is immutable once constructed. If the class has an associated builder, then it has a toBuilder() method, which can be used to convert it back to a builder for making a modified copy.

Because each class is immutable, builder modification will never affect already built class instances.

Asynchronous execution

The default client is synchronous. To switch to asynchronous execution, call the async() method:

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient
import com.withorb.api.models.Customer
import com.withorb.api.models.CustomerCreateParams

// Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
val client: OrbClient = OrbOkHttpClient.fromEnv()

val params: CustomerCreateParams = CustomerCreateParams.builder()
    .email("[email protected]")
    .name("My Customer")
    .build()
val customer: Customer = client.async().customers().create(params)

Or create an asynchronous client from the beginning:

import com.withorb.api.client.OrbClientAsync
import com.withorb.api.client.okhttp.OrbOkHttpClientAsync
import com.withorb.api.models.Customer
import com.withorb.api.models.CustomerCreateParams

// Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
val client: OrbClientAsync = OrbOkHttpClientAsync.fromEnv()

val params: CustomerCreateParams = CustomerCreateParams.builder()
    .email("[email protected]")
    .name("My Customer")
    .build()
val customer: Customer = client.customers().create(params)

The asynchronous client supports the same options as the synchronous one, except most methods are suspending.

Raw responses

The SDK defines methods that deserialize responses into instances of Kotlin classes. However, these methods don't provide access to the response headers, status code, or the raw response body.

To access this data, prefix any HTTP method call on a client or service with withRawResponse():

import com.withorb.api.core.http.Headers
import com.withorb.api.core.http.HttpResponseFor
import com.withorb.api.models.Customer
import com.withorb.api.models.CustomerCreateParams

val params: CustomerCreateParams = CustomerCreateParams.builder()
    .email("[email protected]")
    .name("My Customer")
    .build()
val customer: HttpResponseFor<Customer> = client.customers().withRawResponse().create(params)

val statusCode: Int = customer.statusCode()
val headers: Headers = customer.headers()

You can still deserialize the response into an instance of a Kotlin class if needed:

import com.withorb.api.models.Customer

val parsedCustomer: Customer = customer.parse()

Error handling

The SDK throws custom unchecked exception types:

• OrbServiceException: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:

  Status	Exception
  400	BadRequestException
  401	UnauthorizedException
  403	PermissionDeniedException
  404	NotFoundException
  422	UnprocessableEntityException
  429	RateLimitException
  5xx	InternalServerException
  others	UnexpectedStatusCodeException

• OrbIoException: I/O networking errors.

• OrbInvalidDataException: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.

• OrbException: Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.

Pagination

For methods that return a paginated list of results, this library provides convenient ways access the results either one page at a time, or item-by-item across all pages.

Auto-pagination

To iterate through all results across all pages, you can use autoPager, which automatically handles fetching more pages for you:

Synchronous

import com.withorb.api.models.Coupon
import com.withorb.api.models.CouponListPage

// As a Sequence:
client.coupons().list(params).autoPager()
    .take(50)
    .forEach { coupon -> print(coupon) }

Asynchronous

// As a Flow:
asyncClient.coupons().list(params).autoPager()
    .take(50)
    .collect { coupon -> print(coupon) }

Manual pagination

If none of the above helpers meet your needs, you can also manually request pages one-by-one. A page of results has a data() method to fetch the list of objects, as well as top-level response and other methods to fetch top-level data about the page. It also has methods hasNextPage, getNextPage, and getNextPageParams methods to help with pagination.

import com.withorb.api.models.Coupon
import com.withorb.api.models.CouponListPage

val page = client.coupons().list(params)
while (page != null) {
    for (coupon in page.data) {
        print(coupon)
    }

    page = page.getNextPage()
}

Logging

The SDK uses the standard OkHttp logging interceptor.

Enable logging by setting the ORB_LOG environment variable to info:

$ export ORB_LOG=info

Or to debug for more verbose logging:

$ export ORB_LOG=debug

Webhook Verification

We provide helper methods for verifying that a webhook request came from Orb, and not a malicious third party.

You can use orb.webhooks().verifySignature(body, headers, secret?) or orb.webhooks().unwrap(body, headers, secret?), both of which will raise an error if the signature is invalid.

Note that the body parameter must be the raw JSON string sent from the server (do not parse it first). The .unwrap() method can parse this JSON for you.

Network options

Retries

The SDK automatically retries 2 times by default, with a short exponential backoff.

Only the following error types are retried:

• Connection errors (for example, due to a network connectivity problem)
• 408 Request Timeout
• 409 Conflict
• 429 Rate Limit
• 5xx Internal

The API may also explicitly instruct the SDK to retry or not retry a response.

To set a custom number of retries, configure the client using the maxRetries method:

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient

val client: OrbClient = OrbOkHttpClient.builder()
    .fromEnv()
    .maxRetries(4)
    .build()

Timeouts

Requests time out after 1 minute by default.

To set a custom timeout, configure the method call using the timeout method:

import com.withorb.api.models.Customer
import com.withorb.api.models.CustomerCreateParams

val customer: Customer = client.customers().create(
  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
)

Or configure the default for all method calls at the client level:

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient
import java.time.Duration

val client: OrbClient = OrbOkHttpClient.builder()
    .fromEnv()
    .timeout(Duration.ofSeconds(30))
    .build()

Proxies

To route requests through a proxy, configure the client using the proxy method:

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient
import java.net.InetSocketAddress
import java.net.Proxy

val client: OrbClient = OrbOkHttpClient.builder()
    .fromEnv()
    .proxy(Proxy(
      Proxy.Type.HTTP, InetSocketAddress(
        "https://example.com", 8080
      )
    ))
    .build()

Undocumented API functionality

The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.

Parameters

To set undocumented parameters, call the putAdditionalHeader, putAdditionalQueryParam, or putAdditionalBodyProperty methods on any Params class:

import com.withorb.api.core.JsonValue
import com.withorb.api.models.CustomerCreateParams

val params: CustomerCreateParams = CustomerCreateParams.builder()
    .putAdditionalHeader("Secret-Header", "42")
    .putAdditionalQueryParam("secret_query_param", "42")
    .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))
    .build()

These can be accessed on the built object later using the _additionalHeaders(), _additionalQueryParams(), and _additionalBodyProperties() methods.

To set undocumented parameters on nested headers, query params, or body classes, call the putAdditionalProperty method on the nested class:

import com.withorb.api.core.JsonValue
import com.withorb.api.models.CustomerCreateParams

val params: CustomerCreateParams = CustomerCreateParams.builder()
    .billingAddress(CustomerCreateParams.BillingAddress.builder()
        .putAdditionalProperty("secretProperty", JsonValue.from("42"))
        .build())
    .build()

These properties can be accessed on the nested built object later using the _additionalProperties() method.

To set a documented parameter or property to an undocumented or not yet supported value, pass a JsonValue object to its setter:

import com.withorb.api.core.JsonValue
import com.withorb.api.models.CustomerCreateParams

val params: CustomerCreateParams = CustomerCreateParams.builder()
    .email(JsonValue.from(42))
    .name("My Customer")
    .build()

The most straightforward way to create a JsonValue is using its from(...) method:

import com.withorb.api.core.JsonValue

// Create primitive JSON values
val nullValue: JsonValue = JsonValue.from(null)
val booleanValue: JsonValue = JsonValue.from(true)
val numberValue: JsonValue = JsonValue.from(42)
val stringValue: JsonValue = JsonValue.from("Hello World!")

// Create a JSON array value equivalent to `["Hello", "World"]`
val arrayValue: JsonValue = JsonValue.from(listOf(
  "Hello", "World"
))

// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`
val objectValue: JsonValue = JsonValue.from(mapOf(
  "a" to 1, "b" to 2
))

// Create an arbitrarily nested JSON equivalent to:
// {
//   "a": [1, 2],
//   "b": [3, 4]
// }
val complexValue: JsonValue = JsonValue.from(mapOf(
  "a" to listOf(
    1, 2
  ), "b" to listOf(
    3, 4
  )
))

Response properties

To access undocumented response properties, call the _additionalProperties() method:

import com.withorb.api.core.JsonBoolean
import com.withorb.api.core.JsonNull
import com.withorb.api.core.JsonNumber
import com.withorb.api.core.JsonValue

val additionalProperties: Map<String, JsonValue> = client.customers().create(params)._additionalProperties()
val secretPropertyValue: JsonValue = additionalProperties.get("secretProperty")

val result = when (secretPropertyValue) {
    is JsonNull -> "It's null!"
    is JsonBoolean -> "It's a boolean!"
    is JsonNumber -> "It's a number!"
    // Other types include `JsonMissing`, `JsonString`, `JsonArray`, and `JsonObject`
    else -> "It's something else!"
}

To access a property's raw JSON value, which may be undocumented, call its _ prefixed method:

import com.withorb.api.core.JsonField

val email: JsonField<String> = client.customers().create(params)._email()

if (email.isMissing()) {
  // The property is absent from the JSON response
} else if (email.isNull()) {
  // The property was set to literal null
} else {
  // Check if value was provided as a string
  // Other methods include `asNumber()`, `asBoolean()`, etc.
  val jsonString: String? = email.asString();

  // Try to deserialize into a custom type
  val myObject: MyClass = email.asUnknown()!!.convert(MyClass::class.java)
}

Response validation

In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a String, but the API could return something else.

By default, the SDK will not throw an exception in this case. It will throw OrbInvalidDataException only if you directly access the property.

If you would prefer to check that the response is completely well-typed upfront, then either call validate():

import com.withorb.api.models.Customer

val customer: Customer = client.customers().create(params).validate()

Or configure the method call to validate the response using the responseValidation method:

import com.withorb.api.models.Customer
import com.withorb.api.models.CustomerCreateParams

val customer: Customer = client.customers().create(
  params, RequestOptions.builder().responseValidation(true).build()
)

Or configure the default for all method calls at the client level:

import com.withorb.api.client.OrbClient
import com.withorb.api.client.okhttp.OrbOkHttpClient

val client: OrbClient = OrbOkHttpClient.builder()
    .fromEnv()
    .responseValidation(true)
    .build()

FAQ

Why don't you use plain enum classes?

Kotlin enum classes are not trivially forwards compatible. Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.

Why do you represent fields using JsonField<T> instead of just plain T?

Using JsonField<T> enables a few features:

• Allowing usage of undocumented API functionality
• Lazily validating the API response against the expected shape
• Representing absent vs explicitly null values

Why don't you use data classes?

It is not backwards compatible to add new fields to a data class and we don't want to introduce a breaking change every time we add a field to a class.

Why don't you use checked exceptions?

Checked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.

Checked exceptions:

• Are verbose to handle
• Encourage error handling at the wrong level of abstraction, where nothing can be done about the error
• Are tedious to propagate due to the function coloring problem
• Don't play well with lambdas (also due to the function coloring problem)

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.