com.tryfinch.api.client.FinchClientImpl.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.client
import com.fasterxml.jackson.annotation.JsonProperty
import com.tryfinch.api.core.ClientOptions
import com.tryfinch.api.core.getPackageVersion
import com.tryfinch.api.core.handlers.errorHandler
import com.tryfinch.api.core.handlers.jsonHandler
import com.tryfinch.api.core.handlers.withErrorHandler
import com.tryfinch.api.core.http.HttpMethod
import com.tryfinch.api.core.http.HttpRequest
import com.tryfinch.api.core.http.HttpResponse.Handler
import com.tryfinch.api.core.json
import com.tryfinch.api.errors.FinchError
import com.tryfinch.api.errors.FinchException
import com.tryfinch.api.models.*
import com.tryfinch.api.services.blocking.*
import java.net.URLEncoder
class FinchClientImpl
constructor(
private val clientOptions: ClientOptions,
) : FinchClient {
private val errorHandler: Handler = errorHandler(clientOptions.jsonMapper)
private val clientOptionsWithUserAgent =
if (clientOptions.headers.names().contains("User-Agent")) clientOptions
else
clientOptions
.toBuilder()
.putHeader("User-Agent", "${javaClass.simpleName}/Kotlin ${getPackageVersion()}")
.build()
private val async: FinchClientAsync by lazy { FinchClientAsyncImpl(clientOptions) }
private val accessTokens: AccessTokenService by lazy {
AccessTokenServiceImpl(clientOptionsWithUserAgent)
}
private val hris: HrisService by lazy { HrisServiceImpl(clientOptionsWithUserAgent) }
private val providers: ProviderService by lazy {
ProviderServiceImpl(clientOptionsWithUserAgent)
}
private val account: AccountService by lazy { AccountServiceImpl(clientOptionsWithUserAgent) }
private val webhooks: WebhookService by lazy { WebhookServiceImpl(clientOptionsWithUserAgent) }
private val requestForwarding: RequestForwardingService by lazy {
RequestForwardingServiceImpl(clientOptionsWithUserAgent)
}
private val jobs: JobService by lazy { JobServiceImpl(clientOptionsWithUserAgent) }
private val sandbox: SandboxService by lazy { SandboxServiceImpl(clientOptionsWithUserAgent) }
private val payroll: PayrollService by lazy { PayrollServiceImpl(clientOptionsWithUserAgent) }
private val connect: ConnectService by lazy { ConnectServiceImpl(clientOptionsWithUserAgent) }
private val getAccessTokenHandler: Handler =
jsonHandler(clientOptions.jsonMapper).withErrorHandler(errorHandler)
override fun async(): FinchClientAsync = async
override fun accessTokens(): AccessTokenService = accessTokens
override fun hris(): HrisService = hris
override fun providers(): ProviderService = providers
override fun account(): AccountService = account
override fun webhooks(): WebhookService = webhooks
override fun requestForwarding(): RequestForwardingService = requestForwarding
override fun jobs(): JobService = jobs
override fun sandbox(): SandboxService = sandbox
override fun payroll(): PayrollService = payroll
override fun connect(): ConnectService = connect
// auth helpers:
/** @deprecated use client.accessTokens().create instead */
@Deprecated("use client.accessTokens().create instead", ReplaceWith("accessTokens().create()"))
override fun getAccessToken(
clientId: String,
clientSecret: String,
code: String,
redirectUri: String?
): String {
if (clientOptions.clientId == null) {
throw FinchException("clientId must be set in order to call getAccessToken")
}
if (clientOptions.clientSecret == null) {
throw FinchException("clientSecret must be set in order to call getAccessToken")
}
val request =
HttpRequest.builder()
.method(HttpMethod.POST)
.addPathSegments("auth", "token")
.body(
json(
clientOptions.jsonMapper,
GetAccessTokenParams(
clientId,
clientSecret,
code,
redirectUri,
)
)
)
.build()
return clientOptions.httpClient.execute(request).let {
getAccessTokenHandler.handle(it).accessToken
}
}
override fun getAuthUrl(products: String, redirectUri: String, sandbox: Boolean): String {
if (clientOptions.clientId == null) {
throw FinchException("Expected the clientId to be set in order to call getAuthUrl")
}
return "https://connect.tryfinch.com/authorize" +
"?client_id=${URLEncoder.encode(clientOptions.clientId, Charsets.UTF_8.name())}" +
"&products=${URLEncoder.encode(products, Charsets.UTF_8.name())}" +
"&redirect_uri=${URLEncoder.encode(redirectUri, Charsets.UTF_8.name())}" +
"&sandbox=${if (sandbox) "true" else "false"}"
}
override fun withAccessToken(accessToken: String): FinchClient {
return FinchClientImpl(
ClientOptions.builder()
.httpClient(clientOptions.httpClient)
.jsonMapper(clientOptions.jsonMapper)
.clock(clientOptions.clock)
.baseUrl(clientOptions.baseUrl)
.accessToken(accessToken)
.clientId(clientOptions.clientId)
.clientSecret(clientOptions.clientSecret)
.webhookSecret(clientOptions.webhookSecret)
.headers(clientOptions.headers)
.responseValidation(clientOptions.responseValidation)
.build()
)
}
private data class GetAccessTokenParams(
@JsonProperty("client_id") val clientId: String,
@JsonProperty("client_secret") val clientSecret: String,
@JsonProperty("code") val code: String,
@JsonProperty("redirect_uri") val redirectUri: String?,
)
private data class GetAccessTokenResponse(
@JsonProperty("access_token") val accessToken: String,
@JsonProperty("account_id") val accountId: String,
@JsonProperty("client_type") val clientType: String,
@JsonProperty("company_id") val companyId: String,
@JsonProperty("connection_type") val connectionType: String,
@JsonProperty("products") val products: List,
@JsonProperty("provider_id") val providerId: String,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy