Finch Kotlin API Library

The Finch Kotlin SDK provides convenient access to the Finch REST API from applications written in Kotlin. It includes helper classes with helpful types and documentation for every request and response property.

The Finch Kotlin SDK is similar to the Finch 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.

It is generated with Stainless.

Documentation

The REST API documentation can be found in the Finch Documentation Center.

---

Getting started

Install dependencies

Gradle

implementation("com.tryfinch.api:finch-kotlin:1.11.0")

Maven

<dependency>
    <groupId>com.tryfinch.api</groupId>
    <artifactId>finch-kotlin</artifactId>
    <version>1.11.0</version>
</dependency>

Configure the client

Use FinchOkHttpClient.builder() to configure the client.

Alternately, set the environment with FINCH_CLIENT_ID, FINCH_CLIENT_SECRET or FINCH_WEBHOOK_SECRET, and use FinchOkHttpClient.fromEnv() to read from the environment.

val client = FinchOkHttpClient.fromEnv()

// Note: you can also call fromEnv() from the client builder, for example if you need to set additional properties
val client = FinchOkHttpClient.builder()
    .fromEnv()
    // ... set properties on the builder
    .build()

Property	Environment variable	Required	Default value
clientId	FINCH_CLIENT_ID	false	—
clientSecret	FINCH_CLIENT_SECRET	false	—
webhookSecret	FINCH_WEBHOOK_SECRET	false	—

Read the documentation for more configuration options.

---

Example: creating a resource

To create a new hris directory, first use the HrisDirectoryListParams builder to specify attributes, then pass that to the list method of the directory service.

import com.tryfinch.api.models.HrisDirectoryListPage
import com.tryfinch.api.models.HrisDirectoryListParams
import com.tryfinch.api.models.Page

val params = HrisDirectoryListParams.builder()
    .candidateId("<candidate id>")
    .build()
val page = client.hris().directory().list(params)

Example: listing resources

The Finch API provides a list method to get a paginated list of directory. You can retrieve the first page by:

import com.tryfinch.api.models.IndividualInDirectory
import com.tryfinch.api.models.Page

val page = client.hris().directory().list()
for (directory: IndividualInDirectory in page.individuals()) {
    print(directory)
}

See Pagination below for more information on transparently working with lists of objects without worrying about fetching each page.

---

Requests

Parameters and bodies

To make a request to the Finch API, you generally build an instance of the appropriate Params class.

In Example: creating a resource above, we used the HrisDirectoryListParams.builder() to pass to the list method of the directory service.

Sometimes, the API may support other properties that are not yet supported in the Kotlin SDK types. In that case, you can attach them using the putAdditionalProperty method.

import com.tryfinch.api.models.core.JsonValue
val params = HrisDirectoryListParams.builder()
    // ... normal properties
    .putAdditionalProperty("secret_param", JsonValue.from("4242"))
    .build()

Responses

Response validation

When receiving a response, the Finch Kotlin SDK will deserialize it into instances of the typed model classes. In rare cases, the API may return a response property that doesn't match the expected Kotlin type. If you directly access the mistaken property, the SDK will throw an unchecked FinchInvalidDataException at runtime. If you would prefer to check in advance that that response is completely well-typed, call .validate() on the returned model.

val page = client.hris().directory().list().validate()

Response properties as JSON

In rare cases, you may want to access the underlying JSON value for a response property rather than using the typed version provided by this SDK. Each model property has a corresponding JSON version, with an underscore before the method name, which returns a JsonField value.

val field = responseObj._field

if (field.isMissing()) {
  // Value was not specified in the JSON response
} else if (field.isNull()) {
  // Value was provided as a literal null
} else {
  // See if value was provided as a string
  val jsonString: String? = field.asString();

  // If the value given by the API did not match the shape that the SDK expects
  // you can deserialise into a custom type
  val myObj = responseObj._field.asUnknown()?.convert(MyClass.class)
}

Additional model properties

Sometimes, the server response may include additional properties that are not yet available in this library's types. You can access them using the model's _additionalProperties method:

val secret = operationSupportMatrix._additionalProperties().get("secret_field")

---

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

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

Asynchronous

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

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.

val page = client.hris().directory().list(params)
while (page != null) {
    for (directory in page.individuals) {
        print(directory)
    }

    page = page.getNextPage()
}

---

---

Webhook Verification

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

You can use finch.webhooks().verifySignature(body, headers, secret?) or finch.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.

---

Error handling

This library throws exceptions in a single hierarchy for easy handling:

• FinchException - Base exception for all exceptions

  • FinchServiceException - HTTP errors with a well-formed response body we were able to parse. The exception message and the .debuggingRequestId() will be set by the server.

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

  • FinchIoException - I/O networking errors

  • FinchInvalidDataException - any other exceptions on the client side, e.g.:

    • We failed to serialize the request body
    • We failed to parse the response body (has access to response code and body)

Network options

Retries

Requests that experience certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default. You can provide a maxRetries on the client builder to configure this:

val client = FinchOkHttpClient.builder()
    .fromEnv()
    .maxRetries(4)
    .build()

Timeouts

Requests time out after 1 minute by default. You can configure this on the client builder:

val client = FinchOkHttpClient.builder()
    .fromEnv()
    .timeout(Duration.ofSeconds(30))
    .build()

Proxies

Requests can be routed through a proxy. You can configure this on the client builder:

val client = FinchOkHttpClient.builder()
    .fromEnv()
    .proxy(new Proxy(
        Type.HTTP,
        new InetSocketAddress("proxy.com", 8080)
    ))
    .build()

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.

Requirements

This library requires Java 8 or later.