diff --git a/.release-please-manifest.json b/.release-please-manifest.json index e0dc5001..89c23bac 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "3.1.0" + ".": "3.1.1" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 11cfb2f5..524d097e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/README.md b/README.md index 8a51daf7..d69de054 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -[![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) @@ -27,7 +27,7 @@ The REST API documentation can be found [in the Finch Documentation Center](htt ```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") com.tryfinch.api finch-java - 3.1.0 + 3.1.1 ``` diff --git a/build.gradle.kts b/build.gradle.kts index 427d86ce..23a67a69 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -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 } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccessTokenCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccessTokenCreateParams.kt index 52895682..1ea13c0a 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccessTokenCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccessTokenCreateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountDisconnectParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountDisconnectParams.kt index 39fb907d..4fc38a12 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountDisconnectParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountDisconnectParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountIntrospectParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountIntrospectParams.kt index 1f07bed2..c2e0cc27 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountIntrospectParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountIntrospectParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectSessionNewParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectSessionNewParams.kt index 687966ca..47a87edd 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectSessionNewParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectSessionNewParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectSessionReauthenticateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectSessionReauthenticateParams.kt index 6dd995e6..29fccb13 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectSessionReauthenticateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectSessionReauthenticateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt index 1ddf9377..9d8ffed7 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt index f9ce3ac5..1b2fd5e8 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualRetrieveManyBenefitsParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualRetrieveManyBenefitsParams.kt index 0b271e6c..c49601d4 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualRetrieveManyBenefitsParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualRetrieveManyBenefitsParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualUnenrollManyParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualUnenrollManyParams.kt index 5952a750..29601728 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualUnenrollManyParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualUnenrollManyParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListParams.kt index 3f3f8c2d..00c1a49a 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListSupportedBenefitsParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListSupportedBenefitsParams.kt index 69e36505..ef04edfb 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListSupportedBenefitsParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListSupportedBenefitsParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRetrieveParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRetrieveParams.kt index d97a7bce..d9f46dfa 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRetrieveParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRetrieveParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitUpdateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitUpdateParams.kt index 5c741e26..e1dd4805 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitUpdateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitUpdateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisCompanyRetrieveParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisCompanyRetrieveParams.kt index 0ce8199f..b33fe36f 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisCompanyRetrieveParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisCompanyRetrieveParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListIndividualsParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListIndividualsParams.kt index 205c4872..25dd34df 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListIndividualsParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListIndividualsParams.kt @@ -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?, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListParams.kt index f54344d2..f68fca4d 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListParams.kt @@ -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?, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentListParams.kt index 8c5fc1f6..410ee226 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentListParams.kt @@ -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?, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentRetreiveParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentRetreiveParams.kt index ee938c4c..8b4bdc2d 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentRetreiveParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentRetreiveParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisEmploymentRetrieveManyParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisEmploymentRetrieveManyParams.kt index 16e6ac00..1ba1d76c 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisEmploymentRetrieveManyParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisEmploymentRetrieveManyParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisIndividualRetrieveManyParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisIndividualRetrieveManyParams.kt index 79acf859..7ff5de37 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisIndividualRetrieveManyParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisIndividualRetrieveManyParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementRetrieveManyParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementRetrieveManyParams.kt index a1446c29..d6968cae 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementRetrieveManyParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementRetrieveManyParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPaymentListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPaymentListParams.kt index 66d261fa..2d372bb9 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPaymentListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPaymentListParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedCreateParams.kt index a4a8f5ea..6b1c5463 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedCreateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedListParams.kt index a86984ab..0e94df49 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedListParams.kt @@ -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?, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedRetrieveParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedRetrieveParams.kt index f8454fe4..1291d0a0 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedRetrieveParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobAutomatedRetrieveParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobManualRetrieveParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobManualRetrieveParams.kt index ae0b8f0b..fdab14f7 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobManualRetrieveParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobManualRetrieveParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupListParams.kt index 023edbab..979124f0 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupListParams.kt @@ -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?, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupRetrieveParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupRetrieveParams.kt index a82ebf0b..b355cb27 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupRetrieveParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupRetrieveParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ProviderListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ProviderListParams.kt index 5b6d393d..3adfae98 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ProviderListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ProviderListParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/RequestForwardingForwardParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/RequestForwardingForwardParams.kt index 66c45651..0bfb87e9 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/RequestForwardingForwardParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/RequestForwardingForwardParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxCompanyUpdateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxCompanyUpdateParams.kt index ffdb478e..4843a099 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxCompanyUpdateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxCompanyUpdateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionAccountCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionAccountCreateParams.kt index e4c8a567..44a56f93 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionAccountCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionAccountCreateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionAccountUpdateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionAccountUpdateParams.kt index bc570952..c942a512 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionAccountUpdateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionAccountUpdateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionCreateParams.kt index 62fe40d1..ce413a94 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxConnectionCreateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxDirectoryCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxDirectoryCreateParams.kt index 92349133..5d24502e 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxDirectoryCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxDirectoryCreateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxEmploymentUpdateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxEmploymentUpdateParams.kt index 9a2fe56a..c5a6048e 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxEmploymentUpdateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxEmploymentUpdateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxIndividualUpdateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxIndividualUpdateParams.kt index df20ea2a..920b1758 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxIndividualUpdateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxIndividualUpdateParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobConfigurationRetrieveParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobConfigurationRetrieveParams.kt index 37c5fc5c..92235e08 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobConfigurationRetrieveParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobConfigurationRetrieveParams.kt @@ -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, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobConfigurationUpdateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobConfigurationUpdateParams.kt index 745f1e13..7a610a6c 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobConfigurationUpdateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobConfigurationUpdateParams.kt @@ -18,6 +18,7 @@ import com.tryfinch.api.core.toImmutable import com.tryfinch.api.errors.FinchInvalidDataException import java.util.Objects +/** Update configurations for sandbox jobs */ class SandboxJobConfigurationUpdateParams constructor( private val body: SandboxJobConfigurationUpdateBody, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobCreateParams.kt index 09ceb3b3..ea4ca54d 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxJobCreateParams.kt @@ -18,6 +18,7 @@ import com.tryfinch.api.core.toImmutable import com.tryfinch.api.errors.FinchInvalidDataException import java.util.Objects +/** Enqueue a new sandbox job */ class SandboxJobCreateParams constructor( private val body: SandboxJobCreateBody, diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxPaymentCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxPaymentCreateParams.kt index 11ef1439..2067bf79 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxPaymentCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/SandboxPaymentCreateParams.kt @@ -19,6 +19,7 @@ import com.tryfinch.api.errors.FinchInvalidDataException import java.util.Objects import java.util.Optional +/** Add a new sandbox payment */ class SandboxPaymentCreateParams constructor( private val body: SandboxPaymentCreateBody,