Finch-API · stainless-app · Jan 7, 2025 · Jan 7, 2025 · Jan 7, 2025
@@ -1,3 +1,3 @@
 {
-  ".": "3.1.0"
+  ".": "3.1.1"
 }
@@ -1,5 +1,13 @@
 # Changelog
 
+## 3.1.1 (2025-01-07)
+
+Full Changelog: [v3.1.0...v3.1.1](https://github.com/Finch-API/finch-api-java/compare/v3.1.0...v3.1.1)
+
+### Documentation
+
+* add params class javadocs ([#384](https://github.com/Finch-API/finch-api-java/issues/384)) ([cb2cc7f](https://github.com/Finch-API/finch-api-java/commit/cb2cc7f1773146e00552de74b50e7327b3b14266))
+
 ## 3.1.0 (2025-01-07)
 
 Full Changelog: [v3.0.0...v3.1.0](https://github.com/Finch-API/finch-api-java/compare/v3.0.0...v3.1.0)

@@ -2,7 +2,7 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/3.1.0)
+[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/3.1.1)
 
 <!-- x-release-please-end -->
 
@@ -27,7 +27,7 @@ The REST API documentation can be found [in the Finch Documentation Center](htt
 <!-- x-release-please-start-version -->
 
 ```kotlin
-implementation("com.tryfinch.api:finch-java:3.1.0")
+implementation("com.tryfinch.api:finch-java:3.1.1")
 ```
 
 #### Maven
@@ -36,7 +36,7 @@ implementation("com.tryfinch.api:finch-java:3.1.0")
 <dependency>
     <groupId>com.tryfinch.api</groupId>
     <artifactId>finch-java</artifactId>
-    <version>3.1.0</version>
+    <version>3.1.1</version>
 </dependency>
 ```
 

@@ -4,7 +4,7 @@ plugins {
 
 allprojects {
     group = "com.tryfinch.api"
-    version = "3.1.0" // x-release-please-version
+    version = "3.1.1" // x-release-please-version
 }
 
 
@@ -16,6 +16,7 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/** Exchange the authorization code for an access token */
 class AccessTokenCreateParams
 constructor(
     private val body: AccessTokenCreateBody,

@@ -10,6 +10,7 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/** Disconnect one or more `access_token`s from your application. */
 class AccountDisconnectParams
 constructor(
     private val additionalHeaders: Headers,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Read account information associated with an `access_token` */
 class AccountIntrospectParams
 constructor(
     private val additionalHeaders: Headers,

@@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** Create a new connect session for an employer */
 class ConnectSessionNewParams
 constructor(
     private val body: ConnectSessionNewBody,

@@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** Create a new Connect session for reauthenticating an existing connection */
 class ConnectSessionReauthenticateParams
 constructor(
     private val body: ConnectSessionReauthenticateBody,

@@ -16,6 +16,10 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/**
+ * Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to
+ * view available types for each provider.
+ */
 class HrisBenefitCreateParams
 constructor(
     private val body: HrisBenefitCreateBody,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Lists individuals currently enrolled in a given deduction. */
 class HrisBenefitIndividualEnrolledIdsParams
 constructor(
     private val benefitId: String,

@@ -8,6 +8,7 @@ import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 import java.util.Optional
 
+/** Get enrollment information for the given individuals. */
 class HrisBenefitIndividualRetrieveManyBenefitsParams
 constructor(
     private val benefitId: String,

@@ -16,6 +16,7 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/** Unenroll individuals from a deduction or contribution */
 class HrisBenefitIndividualUnenrollManyParams
 constructor(
     private val benefitId: String,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** List all company-wide deductions and contributions. */
 class HrisBenefitListParams
 constructor(
     private val additionalHeaders: Headers,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Get deductions metadata */
 class HrisBenefitListSupportedBenefitsParams
 constructor(
     private val additionalHeaders: Headers,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Lists deductions and contributions information for a given item */
 class HrisBenefitRetrieveParams
 constructor(
     private val benefitId: String,

@@ -16,6 +16,7 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/** Updates an existing company-wide deduction or contribution */
 class HrisBenefitUpdateParams
 constructor(
     private val benefitId: String,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Read basic company data */
 class HrisCompanyRetrieveParams
 constructor(
     private val additionalHeaders: Headers,

@@ -8,6 +8,7 @@ import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 import java.util.Optional
 
+/** Read company directory and organization structure */
 class HrisDirectoryListIndividualsParams
 constructor(
     private val limit: Long?,

@@ -8,6 +8,7 @@ import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 import java.util.Optional
 
+/** Read company directory and organization structure */
 class HrisDirectoryListParams
 constructor(
     private val limit: Long?,

@@ -13,6 +13,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** **Beta:** This endpoint is in beta and may change. Retrieve a list of company-wide documents. */
 class HrisDocumentListParams
 constructor(
     private val individualIds: List<String>?,

@@ -7,6 +7,10 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/**
+ * **Beta:** This endpoint is in beta and may change. Retrieve details of a specific document by its
+ * ID.
+ */
 class HrisDocumentRetreiveParams
 constructor(
     private val documentId: String,

@@ -15,6 +15,7 @@ import com.tryfinch.api.core.immutableEmptyMap
 import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 
+/** Read individual employment and income data */
 class HrisEmploymentRetrieveManyParams
 constructor(
     private val body: HrisEmploymentRetrieveManyBody,

@@ -16,6 +16,7 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/** Read individual data, excluding income and employment data */
 class HrisIndividualRetrieveManyParams
 constructor(
     private val body: HrisIndividualRetrieveManyBody,

@@ -16,6 +16,11 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/**
+ * Read detailed pay statements for each individual.
+ *
+ * Deduction and contribution types are supported by the payroll systems that supports Benefits.
+ */
 class HrisPayStatementRetrieveManyParams
 constructor(
     private val body: HrisPayStatementRetrieveManyBody,

@@ -8,6 +8,7 @@ import com.tryfinch.api.core.http.QueryParams
 import java.time.LocalDate
 import java.util.Objects
 
+/** Read payroll and contractor related payments by the company. */
 class HrisPaymentListParams
 constructor(
     private val endDate: LocalDate,

@@ -30,6 +30,21 @@ import java.util.Objects
 import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
+/**
+ * Enqueue an automated job.
+ *
+ * `data_sync_all`: Enqueue a job to re-sync all data for a connection. `data_sync_all` has a
+ * concurrency limit of 1 job at a time per connection. This means that if this endpoint is called
+ * while a job is already in progress for this connection, Finch will return the `job_id` of the job
+ * that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per
+ * hour per connection.
+ *
+ * `w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular individual, identified
+ * by `individual_id`. This feature is currently in beta.
+ *
+ * This endpoint is available for _Scale_ tier customers as an add-on. To request access to this
+ * endpoint, please contact your Finch account manager.
+ */
 class JobAutomatedCreateParams
 constructor(
     private val body: JobAutomatedCreateBody,

@@ -8,6 +8,11 @@ import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 import java.util.Optional
 
+/**
+ * Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in
+ * descending order by submission time. For scheduled jobs such as data syncs, only the next
+ * scheduled job is shown.
+ */
 class JobAutomatedListParams
 constructor(
     private val limit: Long?,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Get an automated job by `job_id`. */
 class JobAutomatedRetrieveParams
 constructor(
     private val jobId: String,

@@ -7,6 +7,10 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/**
+ * Get a manual job by `job_id`. Manual jobs are completed by a human and include Assisted Benefits
+ * jobs.
+ */
 class JobManualRetrieveParams
 constructor(
     private val jobId: String,

@@ -9,6 +9,7 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/** Read company pay groups and frequencies */
 class PayrollPayGroupListParams
 constructor(
     private val individualId: String?,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Read information from a single pay group */
 class PayrollPayGroupRetrieveParams
 constructor(
     private val payGroupId: String,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Return details on all available payroll and HR systems. */
 class ProviderListParams
 constructor(
     private val additionalHeaders: Headers,

@@ -16,6 +16,11 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/**
+ * The Forward API allows you to make direct requests to an employment system. If Finch’s unified
+ * API doesn’t have a data model that cleanly fits your needs, then Forward allows you to push or
+ * pull data models directly against an integration’s API.
+ */
 class RequestForwardingForwardParams
 constructor(
     private val body: RequestForwardingForwardBody,

@@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** Update a sandbox company's data */
 class SandboxCompanyUpdateParams
 constructor(
     private val body: SandboxCompanyUpdateBody,

@@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** Create a new account for an existing connection (company/provider pair) */
 class SandboxConnectionAccountCreateParams
 constructor(
     private val body: SandboxConnectionAccountCreateBody,

@@ -16,6 +16,10 @@ import com.tryfinch.api.core.toImmutable
 import java.util.Objects
 import java.util.Optional
 
+/**
+ * Update an existing sandbox account. Change the connection status to understand how the Finch API
+ * responds.
+ */
 class SandboxConnectionAccountUpdateParams
 constructor(
     private val body: SandboxConnectionAccountUpdateBody,

@@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** Create a new connection (new company/provider pair) with a new account */
 class SandboxConnectionCreateParams
 constructor(
     private val body: SandboxConnectionCreateBody,

@@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** Add new individuals to a sandbox company */
 class SandboxDirectoryCreateParams
 constructor(
     private val body: List<IndividualOrEmployment>,

@@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** Update sandbox employment */
 class SandboxEmploymentUpdateParams
 constructor(
     private val individualId: String,

@@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Objects
 import java.util.Optional
 
+/** Update sandbox individual */
 class SandboxIndividualUpdateParams
 constructor(
     private val individualId: String,

@@ -7,6 +7,7 @@ import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import java.util.Objects
 
+/** Get configurations for sandbox jobs */
 class SandboxJobConfigurationRetrieveParams
 constructor(
     private val additionalHeaders: Headers,