com.tryfinch.api.core.ClientOptions.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of finch-kotlin-core Show documentation
Show all versions of finch-kotlin-core Show documentation
The Finch HRIS API provides a unified way to connect to a multitide of HRIS
systems. The API requires an access token issued by Finch.
By default, Organization and Payroll requests use Finch's
[Data Syncs](/developer-resources/Data-Syncs). If a request is made before the
initial sync has completed, Finch will request data live from the provider. The
latency on live requests may range from seconds to minutes depending on the
provider and batch size. For automated integrations, Deductions requests (both
read and write) are always made live to the provider. Latencies may range from
seconds to minutes depending on the provider and batch size.
Employer products are specified by the product parameter, a space-separated list
of products that your application requests from an employer authenticating
through Finch Connect. Valid product names are—
- `company`: Read basic company data
- `directory`: Read company directory and organization structure
- `individual`: Read individual data, excluding income and employment data
- `employment`: Read individual employment and income data
- `payment`: Read payroll and contractor related payments by the company
- `pay_statement`: Read detailed pay statements for each individual
- `benefits`: Create and manage deductions and contributions and enrollment for
an employer
[![Open in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4?action=collection%2Ffork&collection-url=entityId%3D21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4%26entityType%3Dcollection%26workspaceId%3D1edf19bc-e0a8-41e9-ac55-481a4b50790b)
The newest version!
// File generated from our OpenAPI spec by Stainless.
package com.tryfinch.api.core
import com.fasterxml.jackson.databind.json.JsonMapper
import com.tryfinch.api.core.http.Headers
import com.tryfinch.api.core.http.HttpClient
import com.tryfinch.api.core.http.PhantomReachableClosingHttpClient
import com.tryfinch.api.core.http.QueryParams
import com.tryfinch.api.core.http.RetryingHttpClient
import java.time.Clock
import java.util.Base64
class ClientOptions
private constructor(
private val originalHttpClient: HttpClient,
val httpClient: HttpClient,
val jsonMapper: JsonMapper,
val clock: Clock,
val baseUrl: String,
val headers: Headers,
val queryParams: QueryParams,
val responseValidation: Boolean,
val maxRetries: Int,
val accessToken: String?,
val clientId: String?,
val clientSecret: String?,
val webhookSecret: String?,
) {
fun toBuilder() = Builder().from(this)
companion object {
const val PRODUCTION_URL = "https://api.tryfinch.com"
fun builder() = Builder()
fun fromEnv(): ClientOptions = builder().fromEnv().build()
}
class Builder {
private var httpClient: HttpClient? = null
private var jsonMapper: JsonMapper = jsonMapper()
private var clock: Clock = Clock.systemUTC()
private var baseUrl: String = PRODUCTION_URL
private var headers: Headers.Builder = Headers.builder()
private var queryParams: QueryParams.Builder = QueryParams.builder()
private var responseValidation: Boolean = false
private var maxRetries: Int = 2
private var accessToken: String? = null
private var clientId: String? = null
private var clientSecret: String? = null
private var webhookSecret: String? = null
internal fun from(clientOptions: ClientOptions) = apply {
httpClient = clientOptions.originalHttpClient
jsonMapper = clientOptions.jsonMapper
clock = clientOptions.clock
baseUrl = clientOptions.baseUrl
headers = clientOptions.headers.toBuilder()
queryParams = clientOptions.queryParams.toBuilder()
responseValidation = clientOptions.responseValidation
maxRetries = clientOptions.maxRetries
accessToken = clientOptions.accessToken
clientId = clientOptions.clientId
clientSecret = clientOptions.clientSecret
webhookSecret = clientOptions.webhookSecret
}
fun httpClient(httpClient: HttpClient) = apply { this.httpClient = httpClient }
fun jsonMapper(jsonMapper: JsonMapper) = apply { this.jsonMapper = jsonMapper }
fun clock(clock: Clock) = apply { this.clock = clock }
fun baseUrl(baseUrl: String) = apply { this.baseUrl = baseUrl }
fun headers(headers: Headers) = apply {
this.headers.clear()
putAllHeaders(headers)
}
fun headers(headers: Map>) = apply {
this.headers.clear()
putAllHeaders(headers)
}
fun putHeader(name: String, value: String) = apply { headers.put(name, value) }
fun putHeaders(name: String, values: Iterable) = apply { headers.put(name, values) }
fun putAllHeaders(headers: Headers) = apply { this.headers.putAll(headers) }
fun putAllHeaders(headers: Map>) = apply {
this.headers.putAll(headers)
}
fun replaceHeaders(name: String, value: String) = apply { headers.replace(name, value) }
fun replaceHeaders(name: String, values: Iterable) = apply {
headers.replace(name, values)
}
fun replaceAllHeaders(headers: Headers) = apply { this.headers.replaceAll(headers) }
fun replaceAllHeaders(headers: Map>) = apply {
this.headers.replaceAll(headers)
}
fun removeHeaders(name: String) = apply { headers.remove(name) }
fun removeAllHeaders(names: Set) = apply { headers.removeAll(names) }
fun queryParams(queryParams: QueryParams) = apply {
this.queryParams.clear()
putAllQueryParams(queryParams)
}
fun queryParams(queryParams: Map>) = apply {
this.queryParams.clear()
putAllQueryParams(queryParams)
}
fun putQueryParam(key: String, value: String) = apply { queryParams.put(key, value) }
fun putQueryParams(key: String, values: Iterable) = apply {
queryParams.put(key, values)
}
fun putAllQueryParams(queryParams: QueryParams) = apply {
this.queryParams.putAll(queryParams)
}
fun putAllQueryParams(queryParams: Map>) = apply {
this.queryParams.putAll(queryParams)
}
fun replaceQueryParams(key: String, value: String) = apply {
queryParams.replace(key, value)
}
fun replaceQueryParams(key: String, values: Iterable) = apply {
queryParams.replace(key, values)
}
fun replaceAllQueryParams(queryParams: QueryParams) = apply {
this.queryParams.replaceAll(queryParams)
}
fun replaceAllQueryParams(queryParams: Map>) = apply {
this.queryParams.replaceAll(queryParams)
}
fun removeQueryParams(key: String) = apply { queryParams.remove(key) }
fun removeAllQueryParams(keys: Set) = apply { queryParams.removeAll(keys) }
fun responseValidation(responseValidation: Boolean) = apply {
this.responseValidation = responseValidation
}
fun maxRetries(maxRetries: Int) = apply { this.maxRetries = maxRetries }
fun accessToken(accessToken: String?) = apply { this.accessToken = accessToken }
fun clientId(clientId: String?) = apply { this.clientId = clientId }
fun clientSecret(clientSecret: String?) = apply { this.clientSecret = clientSecret }
fun webhookSecret(webhookSecret: String?) = apply { this.webhookSecret = webhookSecret }
fun fromEnv() = apply {
System.getenv("FINCH_CLIENT_ID")?.let { clientId(it) }
System.getenv("FINCH_CLIENT_SECRET")?.let { clientSecret(it) }
System.getenv("FINCH_WEBHOOK_SECRET")?.let { webhookSecret(it) }
}
fun build(): ClientOptions {
checkNotNull(httpClient) { "`httpClient` is required but was not set" }
val headers = Headers.builder()
val queryParams = QueryParams.builder()
headers.put("X-Stainless-Lang", "kotlin")
headers.put("X-Stainless-Arch", getOsArch())
headers.put("X-Stainless-OS", getOsName())
headers.put("X-Stainless-OS-Version", getOsVersion())
headers.put("X-Stainless-Package-Version", getPackageVersion())
headers.put("X-Stainless-Runtime", "JRE")
headers.put("X-Stainless-Runtime-Version", getJavaVersion())
headers.put("Finch-API-Version", "2020-09-17")
accessToken?.let {
if (!it.isEmpty()) {
headers.put("Authorization", "Bearer $it")
}
}
clientId?.let { username ->
clientSecret?.let { password ->
if (!username.isEmpty() && !password.isEmpty()) {
headers.put(
"Authorization",
"Basic ${Base64.getEncoder().encodeToString("$username:$password".toByteArray())}"
)
}
}
}
headers.replaceAll(this.headers.build())
queryParams.replaceAll(this.queryParams.build())
return ClientOptions(
httpClient!!,
PhantomReachableClosingHttpClient(
RetryingHttpClient.builder()
.httpClient(httpClient!!)
.clock(clock)
.maxRetries(maxRetries)
.build()
),
jsonMapper,
clock,
baseUrl,
headers.build(),
queryParams.build(),
responseValidation,
maxRetries,
accessToken,
clientId,
clientSecret,
webhookSecret,
)
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy