diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 1d35995e..4fcc351f 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "8.2.0" + ".": "8.3.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 6d130acd..0fc8637f 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 48 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-a6b05e51c46366a54466c2009f5fdde74e0fa40bbcc6568601a4e3342dd16937.yml -openapi_spec_hash: 084797c220144df17d98eb984dd4cba2 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-166cc05754d8591beda094f4ee6f438f55d5f65d490ab364ea130c5100134375.yml +openapi_spec_hash: 4582a35bbe9fb5404d1e4f804c877fa8 config_hash: 9ae56f40cec7304896138bfad5caf748 diff --git a/CHANGELOG.md b/CHANGELOG.md index d8112a62..45195292 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 8.3.0 (2026-07-15) + +Full Changelog: [v8.2.0...v8.3.0](https://github.com/Finch-API/finch-api-java/compare/v8.2.0...v8.3.0) + +### Features + +* **api:** api update ([36c3cd0](https://github.com/Finch-API/finch-api-java/commit/36c3cd091e42c22722105b43d8a035186c4166f4)) + ## 8.2.0 (2026-07-13) Full Changelog: [v8.1.0...v8.2.0](https://github.com/Finch-API/finch-api-java/compare/v8.1.0...v8.2.0) diff --git a/README.md b/README.md index 2bec2cc3..bb8454f5 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ -[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/8.2.0) -[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/8.2.0/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/8.2.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/8.3.0) +[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/8.3.0/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/8.3.0) @@ -24,7 +24,7 @@ Use the Finch MCP Server to enable AI assistants to interact with this API, allo -The REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/8.2.0). +The REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/8.3.0). @@ -35,7 +35,7 @@ The REST API documentation can be found on [developer.tryfinch.com](https://deve ### Gradle ```kotlin -implementation("com.tryfinch.api:finch-java:8.2.0") +implementation("com.tryfinch.api:finch-java:8.3.0") ``` ### Maven @@ -44,7 +44,7 @@ implementation("com.tryfinch.api:finch-java:8.2.0") com.tryfinch.api finch-java - 8.2.0 + 8.3.0 ``` diff --git a/build.gradle.kts b/build.gradle.kts index 03ec65fc..fa9d1b5d 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -8,7 +8,7 @@ repositories { allprojects { group = "com.tryfinch.api" - version = "8.2.0" // x-release-please-version + version = "8.3.0" // x-release-please-version } subprojects { diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountCreateResponse.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountCreateResponse.kt index 372f2973..0466403c 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountCreateResponse.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountCreateResponse.kt @@ -87,12 +87,12 @@ private constructor( authenticationType.getRequired("authentication_type") /** - * [DEPRECATED] Use `connection_id` to associate a connection with an access token + * The Finch UUID of the company associated with the `access_token`. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * The ID of the new connection @@ -158,10 +158,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -290,8 +287,7 @@ private constructor( this.authenticationType = authenticationType } - /** [DEPRECATED] Use `connection_id` to associate a connection with an access token */ - @Deprecated("deprecated") + /** The Finch UUID of the company associated with the `access_token`. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -301,7 +297,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** The ID of the new connection */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateEvent.kt index 21788eca..180a0b5a 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateEvent.kt @@ -62,13 +62,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -113,10 +112,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -213,11 +209,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -227,7 +219,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateResponse.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateResponse.kt index 366c1f01..fffe773e 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateResponse.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateResponse.kt @@ -76,12 +76,12 @@ private constructor( authenticationType.getRequired("authentication_type") /** - * [DEPRECATED] Use `connection_id` to associate a connection with an access token + * The Finch UUID of the company associated with the `access_token`. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * The ID of the new connection @@ -138,10 +138,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -256,8 +253,7 @@ private constructor( this.authenticationType = authenticationType } - /** [DEPRECATED] Use `connection_id` to associate a connection with an access token */ - @Deprecated("deprecated") + /** The Finch UUID of the company associated with the `access_token`. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -267,7 +263,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** The ID of the new connection */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/BaseWebhookEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/BaseWebhookEvent.kt index edbf9224..7111780f 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/BaseWebhookEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/BaseWebhookEvent.kt @@ -46,13 +46,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -85,10 +84,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -167,11 +163,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -181,7 +173,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/CompanyEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/CompanyEvent.kt index 35806ffc..4cab7046 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/CompanyEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/CompanyEvent.kt @@ -63,13 +63,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -114,10 +113,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -214,11 +210,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -228,7 +220,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectionCreateResponse.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectionCreateResponse.kt index 2b1f38d2..4071a430 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectionCreateResponse.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/ConnectionCreateResponse.kt @@ -91,12 +91,12 @@ private constructor( authenticationType.getRequired("authentication_type") /** - * [DEPRECATED] Use `connection_id` to associate a connection with an access token + * The Finch UUID of the company associated with the `access_token`. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * The ID of the new connection @@ -168,10 +168,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -309,8 +306,7 @@ private constructor( this.authenticationType = authenticationType } - /** [DEPRECATED] Use `connection_id` to associate a connection with an access token */ - @Deprecated("deprecated") + /** The Finch UUID of the company associated with the `access_token`. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -320,7 +316,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** The ID of the new connection */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/CreateAccessTokenResponse.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/CreateAccessTokenResponse.kt index f96a1d98..e9b14099 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/CreateAccessTokenResponse.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/CreateAccessTokenResponse.kt @@ -162,12 +162,11 @@ private constructor( fun accountId(): Optional = accountId.getOptional("account_id") /** - * [DEPRECATED] Use `connection_id` to identify the connection instead of this company ID + * The Finch UUID of the company associated with the `access_token`. * * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the * server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): Optional = companyId.getOptional("company_id") /** @@ -269,10 +268,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [customerId]. @@ -505,10 +501,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Use `connection_id` to identify the connection instead of this company ID - */ - @Deprecated("deprecated") + /** The Finch UUID of the company associated with the `access_token`. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -518,7 +511,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/DirectoryEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/DirectoryEvent.kt index 335119c1..00856359 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/DirectoryEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/DirectoryEvent.kt @@ -62,13 +62,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -113,10 +112,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -213,11 +209,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -227,7 +219,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/EmploymentEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/EmploymentEvent.kt index aef62c9c..b8f7c7ad 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/EmploymentEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/EmploymentEvent.kt @@ -62,13 +62,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -113,10 +112,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -213,11 +209,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -227,7 +219,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ 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 d5174fdc..908aa05f 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 @@ -35,7 +35,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -136,7 +139,10 @@ private constructor( additionalQueryParams = hrisBenefitCreateParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrollManyParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrollManyParams.kt index ecbfe45c..7a7b634c 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrollManyParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrollManyParams.kt @@ -41,7 +41,10 @@ private constructor( fun benefitId(): Optional = Optional.ofNullable(benefitId) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Array of the individual_id to enroll and a configuration object. */ @@ -92,7 +95,10 @@ private constructor( /** Alias for calling [Builder.benefitId] with `benefitId.orElse(null)`. */ fun benefitId(benefitId: Optional) = benefitId(benefitId.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 ee3f731d..86dc5e06 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 @@ -21,7 +21,10 @@ private constructor( fun benefitId(): Optional = Optional.ofNullable(benefitId) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -67,7 +70,10 @@ private constructor( /** Alias for calling [Builder.benefitId] with `benefitId.orElse(null)`. */ fun benefitId(benefitId: Optional) = benefitId(benefitId.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 a6f6df14..85fa7778 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 @@ -22,7 +22,10 @@ private constructor( fun benefitId(): Optional = Optional.ofNullable(benefitId) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -78,7 +81,10 @@ private constructor( /** Alias for calling [Builder.benefitId] with `benefitId.orElse(null)`. */ fun benefitId(benefitId: Optional) = benefitId(benefitId.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 84930e4f..6312e2eb 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 @@ -33,7 +33,10 @@ private constructor( fun benefitId(): Optional = Optional.ofNullable(benefitId) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -99,7 +102,10 @@ private constructor( /** Alias for calling [Builder.benefitId] with `benefitId.orElse(null)`. */ fun benefitId(benefitId: Optional) = benefitId(benefitId.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 8391141c..d0da39bd 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 @@ -18,7 +18,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -51,7 +54,10 @@ private constructor( additionalQueryParams = hrisBenefitListParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 37dea9e5..5e99311e 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 @@ -18,7 +18,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -57,7 +60,10 @@ private constructor( hrisBenefitListSupportedBenefitsParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRegisterParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRegisterParams.kt index 05501115..1fdcded8 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRegisterParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRegisterParams.kt @@ -32,7 +32,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -114,7 +117,10 @@ private constructor( additionalQueryParams = hrisBenefitRegisterParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 35f93992..b6364c67 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 @@ -21,7 +21,10 @@ private constructor( fun benefitId(): Optional = Optional.ofNullable(benefitId) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -63,7 +66,10 @@ private constructor( /** Alias for calling [Builder.benefitId] with `benefitId.orElse(null)`. */ fun benefitId(benefitId: Optional) = benefitId(benefitId.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 3387c8f0..2a2aaf6c 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 @@ -32,7 +32,10 @@ private constructor( fun benefitId(): Optional = Optional.ofNullable(benefitId) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -91,7 +94,10 @@ private constructor( /** Alias for calling [Builder.benefitId] with `benefitId.orElse(null)`. */ fun benefitId(benefitId: Optional) = benefitId(benefitId.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 591a4d85..d6b2a9df 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 @@ -18,7 +18,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -53,7 +56,10 @@ private constructor( additionalQueryParams = hrisCompanyRetrieveParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 4c951d1b..e9d4866f 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 @@ -21,7 +21,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Number of employees to return (defaults to 100, maximum 10000) */ @@ -69,7 +72,10 @@ private constructor( hrisDirectoryListIndividualsParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 d826f3bc..0f5defdd 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 @@ -20,7 +20,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Number of employees to return (defaults to 100, maximum 10000) */ @@ -63,7 +66,10 @@ private constructor( additionalQueryParams = hrisDirectoryListParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 52ecf592..54eea08f 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 @@ -26,7 +26,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -82,7 +85,10 @@ private constructor( additionalQueryParams = hrisDocumentListParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 fbacf3ff..df2717f3 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 @@ -24,7 +24,10 @@ private constructor( fun documentId(): Optional = Optional.ofNullable(documentId) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -66,7 +69,10 @@ private constructor( /** Alias for calling [Builder.documentId] with `documentId.orElse(null)`. */ fun documentId(documentId: Optional) = documentId(documentId.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 230265ed..dcd947e2 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 @@ -31,7 +31,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -91,7 +94,10 @@ private constructor( hrisEmploymentRetrieveManyParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 64731fa0..2bf0602c 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 @@ -31,7 +31,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -104,7 +107,10 @@ private constructor( hrisIndividualRetrieveManyParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemListParams.kt index bde40613..677fc045 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemListParams.kt @@ -40,7 +40,10 @@ private constructor( */ fun endDate(): Optional = Optional.ofNullable(endDate) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Case-insensitive partial match search by pay statement item name. */ @@ -127,7 +130,10 @@ private constructor( /** Alias for calling [Builder.endDate] with `endDate.orElse(null)`. */ fun endDate(endDate: Optional) = endDate(endDate.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleCreateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleCreateParams.kt index 6df6e3e7..c1e33874 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleCreateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleCreateParams.kt @@ -35,7 +35,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to create the rule for. */ + /** + * The entity IDs to create the rule for. Provide exactly one entity ID per request; a maximum + * of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -153,7 +156,10 @@ private constructor( hrisPayStatementItemRuleCreateParams.additionalQueryParams.toBuilder() } - /** The entity IDs to create the rule for. */ + /** + * The entity IDs to create the rule for. Provide exactly one entity ID per request; a + * maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleDeleteParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleDeleteParams.kt index a2b58643..41088c20 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleDeleteParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleDeleteParams.kt @@ -23,7 +23,10 @@ private constructor( fun ruleId(): Optional = Optional.ofNullable(ruleId) - /** The entity IDs to delete the rule for. */ + /** + * The entity IDs to delete the rule for. Provide exactly one entity ID per request; a maximum + * of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional body properties to send with the request. */ @@ -75,7 +78,10 @@ private constructor( /** Alias for calling [Builder.ruleId] with `ruleId.orElse(null)`. */ fun ruleId(ruleId: Optional) = ruleId(ruleId.getOrNull()) - /** The entity IDs to delete the rule for. */ + /** + * The entity IDs to delete the rule for. Provide exactly one entity ID per request; a + * maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleListParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleListParams.kt index e4c3ff2b..17ad4dfb 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleListParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleListParams.kt @@ -18,7 +18,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to retrieve rules for. */ + /** + * The entity IDs to retrieve rules for. Provide exactly one entity ID per request; a maximum of + * one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -56,7 +59,10 @@ private constructor( hrisPayStatementItemRuleListParams.additionalQueryParams.toBuilder() } - /** The entity IDs to retrieve rules for. */ + /** + * The entity IDs to retrieve rules for. Provide exactly one entity ID per request; a + * maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleUpdateParams.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleUpdateParams.kt index 8c914825..7b75ffca 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleUpdateParams.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleUpdateParams.kt @@ -31,7 +31,10 @@ private constructor( fun ruleId(): Optional = Optional.ofNullable(ruleId) - /** The entity IDs to update the rule for. */ + /** + * The entity IDs to update the rule for. Provide exactly one entity ID per request; a maximum + * of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -89,7 +92,10 @@ private constructor( /** Alias for calling [Builder.ruleId] with `ruleId.orElse(null)`. */ fun ruleId(ruleId: Optional) = ruleId(ruleId.getOrNull()) - /** The entity IDs to update the rule for. */ + /** + * The entity IDs to update the rule for. Provide exactly one entity ID per request; a + * maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 a545620f..71299384 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 @@ -35,7 +35,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** @@ -95,7 +98,10 @@ private constructor( hrisPayStatementRetrieveManyParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 71e71146..7f8a37a3 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 @@ -34,7 +34,10 @@ private constructor( */ fun startDate(): LocalDate = startDate - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -89,7 +92,10 @@ private constructor( */ fun startDate(startDate: LocalDate) = apply { this.startDate = startDate } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/IndividualEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/IndividualEvent.kt index b8b54b8e..f34c270c 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/IndividualEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/IndividualEvent.kt @@ -62,13 +62,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -113,10 +112,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -213,11 +209,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -227,7 +219,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/Introspection.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/Introspection.kt index d9197495..97e21f19 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/Introspection.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/Introspection.kt @@ -205,13 +205,11 @@ private constructor( authenticationMethods.getOptional("authentication_methods") /** - * [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection instead of this - * company ID + * The Finch UUID of the company associated with the `access_token`. * * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the * server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): Optional = companyId.getOptional("company_id") /** @@ -366,10 +364,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [customerEmail]. @@ -671,11 +666,7 @@ private constructor( } } - /** - * [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection instead of - * this company ID - */ - @Deprecated("deprecated") + /** The Finch UUID of the company associated with the `access_token`. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -685,7 +676,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobCompletionEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobCompletionEvent.kt index 7a423749..b8fa1899 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobCompletionEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/JobCompletionEvent.kt @@ -62,13 +62,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -113,10 +112,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -213,11 +209,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -227,7 +219,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayStatementEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayStatementEvent.kt index d72a840c..7423dede 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayStatementEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PayStatementEvent.kt @@ -62,13 +62,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -113,10 +112,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -213,11 +209,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -227,7 +219,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ diff --git a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PaymentEvent.kt b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PaymentEvent.kt index 2499e4eb..e3dfce77 100644 --- a/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PaymentEvent.kt +++ b/finch-java-core/src/main/kotlin/com/tryfinch/api/models/PaymentEvent.kt @@ -64,13 +64,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String = accountId.getRequired("account_id") /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. + * Unique Finch ID of the company for which data has been updated. * * @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly * missing or null (e.g. if the server responded with an unexpected value). */ - @Deprecated("deprecated") fun companyId(): String = companyId.getRequired("company_id") + fun companyId(): String = companyId.getRequired("company_id") /** * Unique Finch ID of the connection associated with the webhook event. @@ -115,10 +114,7 @@ private constructor( * * Unlike [companyId], this method doesn't throw if the JSON field has an unexpected type. */ - @Deprecated("deprecated") - @JsonProperty("company_id") - @ExcludeMissing - fun _companyId(): JsonField = companyId + @JsonProperty("company_id") @ExcludeMissing fun _companyId(): JsonField = companyId /** * Returns the raw JSON value of [connectionId]. @@ -215,11 +211,7 @@ private constructor( @Deprecated("deprecated") fun accountId(accountId: JsonField) = apply { this.accountId = accountId } - /** - * [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - * `connection_id` instead to identify the connection associated with this event. - */ - @Deprecated("deprecated") + /** Unique Finch ID of the company for which data has been updated. */ fun companyId(companyId: String) = companyId(JsonField.of(companyId)) /** @@ -229,7 +221,6 @@ private constructor( * This method is primarily for setting the field to an undocumented or not yet supported * value. */ - @Deprecated("deprecated") fun companyId(companyId: JsonField) = apply { this.companyId = companyId } /** Unique Finch ID of the connection associated with the webhook event. */ 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 0db00332..9b264d00 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 @@ -20,7 +20,10 @@ private constructor( private val additionalQueryParams: QueryParams, ) : Params { - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) fun individualId(): Optional = Optional.ofNullable(individualId) @@ -63,7 +66,10 @@ private constructor( additionalQueryParams = payrollPayGroupListParams.additionalQueryParams.toBuilder() } - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } 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 54458f70..680685cd 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 @@ -21,7 +21,10 @@ private constructor( fun payGroupId(): Optional = Optional.ofNullable(payGroupId) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID per + * request; a maximum of one is accepted. + */ fun entityIds(): Optional> = Optional.ofNullable(entityIds) /** Additional headers to send with the request. */ @@ -64,7 +67,10 @@ private constructor( /** Alias for calling [Builder.payGroupId] with `payGroupId.orElse(null)`. */ fun payGroupId(payGroupId: Optional) = payGroupId(payGroupId.getOrNull()) - /** The entity IDs to specify which entities' data to access. */ + /** + * The entity IDs to specify which entities' data to access. Provide exactly one entity ID + * per request; a maximum of one is accepted. + */ fun entityIds(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() }