JetBrains Grazie Kotlin API Library

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

It is generated with Stainless.

KDocs are available on javadoc.io.

Installation

Gradle

implementation("com.jetbrains.grazie.api:jetbrains-grazie-kotlin:0.0.1")

Maven

<dependency>
  <groupId>com.jetbrains.grazie.api</groupId>
  <artifactId>jetbrains-grazie-kotlin</artifactId>
  <version>0.0.1</version>
</dependency>

Requirements

This library requires Java 8 or later.

Usage

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtParams
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtResponse

// Configures using the `jetbrainsgrazie.accessToken`, `jetbrainsgrazie.bearerToken` and `jetbrainsgrazie.baseUrl` system properties
// Or configures using the `JETBRAINS_GRAZIE_ACCESS_TOKEN`, `JETBRAINS_GRAZIE_BEARER_TOKEN` and `JETBRAINS_GRAZIE_BASE_URL` environment variables
val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.fromEnv()

val params: AccessTokenCreateJwtParams = AccessTokenCreateJwtParams.builder()
    .licenseId("jbv2_abc123")
    .build()
val response: AccessTokenCreateJwtResponse = client.auth().accessTokens().createJwt(params)

Client configuration

Configure the client using system properties or environment variables:

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient

// Configures using the `jetbrainsgrazie.accessToken`, `jetbrainsgrazie.bearerToken` and `jetbrainsgrazie.baseUrl` system properties
// Or configures using the `JETBRAINS_GRAZIE_ACCESS_TOKEN`, `JETBRAINS_GRAZIE_BEARER_TOKEN` and `JETBRAINS_GRAZIE_BASE_URL` environment variables
val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.fromEnv()

Or manually:

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient

val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.builder()
    .accessToken("My Access Token")
    .build()

Or using a combination of the two approaches:

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient

val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.builder()
    // Configures using the `jetbrainsgrazie.accessToken`, `jetbrainsgrazie.bearerToken` and `jetbrainsgrazie.baseUrl` system properties
    // Or configures using the `JETBRAINS_GRAZIE_ACCESS_TOKEN`, `JETBRAINS_GRAZIE_BEARER_TOKEN` and `JETBRAINS_GRAZIE_BASE_URL` environment variables
    .fromEnv()
    .accessToken("My Access Token")
    .build()

See this table for the available options:

Setter	System property	Environment variable	Required	Default value
`accessToken`	`jetbrainsgrazie.accessToken`	`JETBRAINS_GRAZIE_ACCESS_TOKEN`	false	-
`bearerToken`	`jetbrainsgrazie.bearerToken`	`JETBRAINS_GRAZIE_BEARER_TOKEN`	false	-
`baseUrl`	`jetbrainsgrazie.baseUrl`	`JETBRAINS_GRAZIE_BASE_URL`	true	`"https://api.example.com"`

System properties take precedence over environment variables.

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.

Modifying configuration

To temporarily use a modified client configuration, while reusing the same connection and thread pools, call withOptions() on any client or service:

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient

val clientWithOptions: JetBrainsGrazieClient = client.withOptions {
    it.baseUrl("https://example.com")
    it.maxRetries(42)
}

The withOptions() method does not affect the original client or service.

Requests and responses

To send a request to the JetBrains Grazie 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.auth().accessTokens().createJwt(...) should be called with an instance of AccessTokenCreateJwtParams, and it will return an instance of AccessTokenCreateJwtResponse.

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.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtParams
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtResponse

// Configures using the `jetbrainsgrazie.accessToken`, `jetbrainsgrazie.bearerToken` and `jetbrainsgrazie.baseUrl` system properties
// Or configures using the `JETBRAINS_GRAZIE_ACCESS_TOKEN`, `JETBRAINS_GRAZIE_BEARER_TOKEN` and `JETBRAINS_GRAZIE_BASE_URL` environment variables
val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.fromEnv()

val params: AccessTokenCreateJwtParams = AccessTokenCreateJwtParams.builder()
    .licenseId("jbv2_abc123")
    .build()
val response: AccessTokenCreateJwtResponse = client.async().auth().accessTokens().createJwt(params)

Or create an asynchronous client from the beginning:

import com.jetbrains.grazie.api.client.JetBrainsGrazieClientAsync
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClientAsync
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtParams
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtResponse

// Configures using the `jetbrainsgrazie.accessToken`, `jetbrainsgrazie.bearerToken` and `jetbrainsgrazie.baseUrl` system properties
// Or configures using the `JETBRAINS_GRAZIE_ACCESS_TOKEN`, `JETBRAINS_GRAZIE_BEARER_TOKEN` and `JETBRAINS_GRAZIE_BASE_URL` environment variables
val client: JetBrainsGrazieClientAsync = JetBrainsGrazieOkHttpClientAsync.fromEnv()

val params: AccessTokenCreateJwtParams = AccessTokenCreateJwtParams.builder()
    .licenseId("jbv2_abc123")
    .build()
val response: AccessTokenCreateJwtResponse = client.auth().accessTokens().createJwt(params)

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

Streaming

The SDK defines methods that return response "chunk" streams, where each chunk can be individually processed as soon as it arrives instead of waiting on the full response. Streaming methods generally correspond to SSE or JSONL responses.

Some of these methods may have streaming and non-streaming variants, but a streaming method will always have a Streaming suffix in its name, even if it doesn't have a non-streaming variant.

These streaming methods return StreamResponse for synchronous clients:

client.chat().streamStreaming(params).use { response ->
    response.asSequence().forEach { println(it) }
    println("No more chunks!")
}

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.jetbrains.grazie.api.core.http.Headers
import com.jetbrains.grazie.api.core.http.HttpResponseFor
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtParams
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtResponse

val params: AccessTokenCreateJwtParams = AccessTokenCreateJwtParams.builder()
    .licenseId("jbv2_abc123")
    .build()
val response: HttpResponseFor<AccessTokenCreateJwtResponse> = client.auth().accessTokens().withRawResponse().createJwt(params)

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

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

import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtResponse

val parsedResponse: AccessTokenCreateJwtResponse = response.parse()

Error handling

The SDK throws custom unchecked exception types:

JetBrainsGrazieServiceException: 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`

SseException is thrown for errors encountered during SSE streaming after a successful initial HTTP response.

JetBrainsGrazieIoException: I/O networking errors.
JetBrainsGrazieRetryableException: Generic error indicating a failure that could be retried by the client.
JetBrainsGrazieInvalidDataException: 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.
JetBrainsGrazieException: 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.

Logging

The SDK uses the standard OkHttp logging interceptor.

Enable logging by setting the JETBRAINS_GRAZIE_LOG environment variable to info:

export JETBRAINS_GRAZIE_LOG=info

Or to debug for more verbose logging:

export JETBRAINS_GRAZIE_LOG=debug

ProGuard and R8

Although the SDK uses reflection, it is still usable with ProGuard and R8 because jetbrains-grazie-kotlin-core is published with a configuration file containing keep rules.

ProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.

Jackson

The SDK depends on Jackson for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.

The SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).

If the SDK threw an exception, but you're certain the version is compatible, then disable the version check using the checkJacksonVersionCompatibility on JetBrainsGrazieOkHttpClient or JetBrainsGrazieOkHttpClientAsync.

Caution

We make no guarantee that the SDK works correctly when the Jackson version check is disabled.

Network options

Retries

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

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 request.

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

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient

val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.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.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtResponse

val response: AccessTokenCreateJwtResponse = client.auth().accessTokens().createJwt(
  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
)

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

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient
import java.time.Duration

val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.builder()
    .fromEnv()
    .timeout(Duration.ofSeconds(30))
    .build()

Proxies

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

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient
import java.net.InetSocketAddress
import java.net.Proxy

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

HTTPS

Note

Most applications should not call these methods, and instead use the system defaults. The defaults include special optimizations that can be lost if the implementations are modified.

To configure how HTTPS connections are secured, configure the client using the sslSocketFactory, trustManager, and hostnameVerifier methods:

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient

val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.builder()
    .fromEnv()
    // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.
    .sslSocketFactory(yourSSLSocketFactory)
    .trustManager(yourTrustManager)
    .hostnameVerifier(yourHostnameVerifier)
    .build()

Custom HTTP client

The SDK consists of three artifacts:

jetbrains-grazie-kotlin-core
- Contains core SDK logic
- Does not depend on OkHttp
- Exposes JetBrainsGrazieClient, JetBrainsGrazieClientAsync, JetBrainsGrazieClientImpl, and JetBrainsGrazieClientAsyncImpl, all of which can work with any HTTP client
jetbrains-grazie-kotlin-client-okhttp
- Depends on OkHttp
- Exposes JetBrainsGrazieOkHttpClient and JetBrainsGrazieOkHttpClientAsync, which provide a way to construct JetBrainsGrazieClientImpl and JetBrainsGrazieClientAsyncImpl, respectively, using OkHttp
jetbrains-grazie-kotlin
- Depends on and exposes the APIs of both jetbrains-grazie-kotlin-core and jetbrains-grazie-kotlin-client-okhttp
- Does not have its own logic

This structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.

Customized `OkHttpClient`

Tip

Try the available network options before replacing the default client.

To use a customized OkHttpClient:

Replace your jetbrains-grazie-kotlin dependency with jetbrains-grazie-kotlin-core
Copy jetbrains-grazie-kotlin-client-okhttp's OkHttpClient class into your code and customize it
Construct JetBrainsGrazieClientImpl or JetBrainsGrazieClientAsyncImpl, similarly to JetBrainsGrazieOkHttpClient or JetBrainsGrazieOkHttpClientAsync, using your customized client

Completely custom HTTP client

To use a completely custom HTTP client:

Replace your jetbrains-grazie-kotlin dependency with jetbrains-grazie-kotlin-core
Write a class that implements the HttpClient interface
Construct JetBrainsGrazieClientImpl or JetBrainsGrazieClientAsyncImpl, similarly to JetBrainsGrazieOkHttpClient or JetBrainsGrazieOkHttpClientAsync, using your new client class

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.jetbrains.grazie.api.core.JsonValue
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtParams

val params: AccessTokenCreateJwtParams = AccessTokenCreateJwtParams.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.jetbrains.grazie.api.core.JsonValue
import com.jetbrains.grazie.api.models.chat.ChatStreamParams

val params: ChatStreamParams = ChatStreamParams.builder()
    .chat(ChatStreamParams.Chat.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.jetbrains.grazie.api.core.JsonValue
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtParams

val params: AccessTokenCreateJwtParams = AccessTokenCreateJwtParams.builder()
    .licenseId(JsonValue.from(42))
    .build()

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

import com.jetbrains.grazie.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
  )
))

Normally a Builder class's build method will throw IllegalStateException if any required parameter or property is unset.

To forcibly omit a required parameter or property, pass JsonMissing:

import com.jetbrains.grazie.api.core.JsonMissing
import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtParams

val params: AccessTokenCreateJwtParams = AccessTokenCreateJwtParams.builder()
    .licenseId(JsonMissing.of())
    .build()

Response properties

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

import com.jetbrains.grazie.api.core.JsonBoolean
import com.jetbrains.grazie.api.core.JsonNull
import com.jetbrains.grazie.api.core.JsonNumber
import com.jetbrains.grazie.api.core.JsonValue

val additionalProperties: Map<String, JsonValue> = client.auth().accessTokens().createJwt(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.jetbrains.grazie.api.core.JsonField

val licenseId: JsonField<String> = client.auth().accessTokens().createJwt(params)._licenseId()

if (licenseId.isMissing()) {
  // The property is absent from the JSON response
} else if (licenseId.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? = licenseId.asString();

  // Try to deserialize into a custom type
  val myObject: MyClass = licenseId.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 JetBrainsGrazieInvalidDataException 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.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtResponse

val response: AccessTokenCreateJwtResponse = client.auth().accessTokens().createJwt(params).validate()

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

import com.jetbrains.grazie.api.models.auth.accesstokens.AccessTokenCreateJwtResponse

val response: AccessTokenCreateJwtResponse = client.auth().accessTokens().createJwt(
  params, RequestOptions.builder().responseValidation(true).build()
)

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

import com.jetbrains.grazie.api.client.JetBrainsGrazieClient
import com.jetbrains.grazie.api.client.okhttp.JetBrainsGrazieOkHttpClient

val client: JetBrainsGrazieClient = JetBrainsGrazieOkHttpClient.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:

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.)
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.

Profiles