diff --git a/.release-please-manifest.json b/.release-please-manifest.json index dcb585677..430e28e56 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "9.2.0" + ".": "9.3.0" } diff --git a/.stats.yml b/.stats.yml index 6d130acda..0fc8637f9 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 95332ea3b..a1c7e861e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 9.3.0 (2026-07-15) + +Full Changelog: [v9.2.0...v9.3.0](https://github.com/Finch-API/finch-api-kotlin/compare/v9.2.0...v9.3.0) + +### Features + +* **api:** api update ([82b2d12](https://github.com/Finch-API/finch-api-kotlin/commit/82b2d123fdcd57e043a67d9309e5de7ba20dc352)) + ## 9.2.0 (2026-07-13) Full Changelog: [v9.1.0...v9.2.0](https://github.com/Finch-API/finch-api-kotlin/compare/v9.1.0...v9.2.0) diff --git a/README.md b/README.md index ecb969e47..498504a61 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ -[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-kotlin)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-kotlin/9.2.0) -[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-kotlin/9.2.0/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/9.2.0) +[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-kotlin)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-kotlin/9.3.0) +[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-kotlin/9.3.0/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/9.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/). KDocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/9.2.0). +The REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). KDocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/9.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-kotlin:9.2.0") +implementation("com.tryfinch.api:finch-kotlin:9.3.0") ``` ### Maven @@ -44,7 +44,7 @@ implementation("com.tryfinch.api:finch-kotlin:9.2.0") com.tryfinch.api finch-kotlin - 9.2.0 + 9.3.0 ``` diff --git a/build.gradle.kts b/build.gradle.kts index 13ae9be90..e1bb90998 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -8,7 +8,7 @@ repositories { allprojects { group = "com.tryfinch.api" - version = "9.2.0" // x-release-please-version + version = "9.3.0" // x-release-please-version } subprojects { diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountCreateResponse.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountCreateResponse.kt index 957030cd2..3ce2f0794 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountCreateResponse.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountCreateResponse.kt @@ -86,12 +86,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 @@ -157,10 +157,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]. @@ -288,8 +285,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)) /** @@ -299,7 +295,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateEvent.kt index 6f770eb42..667a47ff4 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateEvent.kt @@ -60,13 +60,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. @@ -111,10 +110,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]. @@ -210,11 +206,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)) /** @@ -224,7 +216,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateResponse.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateResponse.kt index fadca9ae8..af0d0fbdd 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateResponse.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/AccountUpdateResponse.kt @@ -75,12 +75,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 @@ -137,10 +137,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]. @@ -254,8 +251,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)) /** @@ -265,7 +261,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/BaseWebhookEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/BaseWebhookEvent.kt index 5c8b3f5a2..ff5491ad9 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/BaseWebhookEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/BaseWebhookEvent.kt @@ -45,13 +45,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. @@ -84,10 +83,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]. @@ -165,11 +161,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)) /** @@ -179,7 +171,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/CompanyEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/CompanyEvent.kt index 0d49a6231..48dc0298f 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/CompanyEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/CompanyEvent.kt @@ -61,13 +61,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. @@ -112,10 +111,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]. @@ -211,11 +207,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)) /** @@ -225,7 +217,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/ConnectionCreateResponse.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/ConnectionCreateResponse.kt index 52dd61867..add402124 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/ConnectionCreateResponse.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/ConnectionCreateResponse.kt @@ -89,12 +89,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 @@ -166,10 +166,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]. @@ -306,8 +303,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)) /** @@ -317,7 +313,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/CreateAccessTokenResponse.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/CreateAccessTokenResponse.kt index 2f726bc9b..c1714002c 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/CreateAccessTokenResponse.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/CreateAccessTokenResponse.kt @@ -159,12 +159,12 @@ private constructor( @Deprecated("deprecated") fun accountId(): String? = accountId.getNullable("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(): String? = companyId.getNullable("company_id") + fun companyId(): String? = companyId.getNullable("company_id") /** * The ID of your customer you provided to Finch when a connect session was created for this @@ -265,10 +265,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]. @@ -500,10 +497,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)) /** @@ -513,7 +507,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/DirectoryEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/DirectoryEvent.kt index 98779f47c..ac7c90768 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/DirectoryEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/DirectoryEvent.kt @@ -60,13 +60,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. @@ -111,10 +110,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]. @@ -210,11 +206,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)) /** @@ -224,7 +216,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/EmploymentEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/EmploymentEvent.kt index c62cfafa5..d55c055b9 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/EmploymentEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/EmploymentEvent.kt @@ -60,13 +60,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. @@ -111,10 +110,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]. @@ -210,11 +206,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)) /** @@ -224,7 +216,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt index ce9135731..f7f9d35b7 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt @@ -33,7 +33,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(): List? = entityIds /** @@ -132,7 +135,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrollManyParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrollManyParams.kt index 4e8525bc1..2890aece5 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrollManyParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrollManyParams.kt @@ -39,7 +39,10 @@ private constructor( fun benefitId(): String? = 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(): List? = entityIds /** Array of the individual_id to enroll and a configuration object. */ @@ -86,7 +89,10 @@ private constructor( fun benefitId(benefitId: String?) = apply { this.benefitId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt index dda22473b..0811ea8d2 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt @@ -19,7 +19,10 @@ private constructor( fun benefitId(): String? = 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(): List? = entityIds /** Additional headers to send with the request. */ @@ -61,7 +64,10 @@ private constructor( fun benefitId(benefitId: String?) = apply { this.benefitId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualRetrieveManyBenefitsParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualRetrieveManyBenefitsParams.kt index 3d1594144..46f4c35e8 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualRetrieveManyBenefitsParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualRetrieveManyBenefitsParams.kt @@ -20,7 +20,10 @@ private constructor( fun benefitId(): String? = 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(): List? = entityIds /** @@ -72,7 +75,10 @@ private constructor( fun benefitId(benefitId: String?) = apply { this.benefitId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualUnenrollManyParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualUnenrollManyParams.kt index 62831c684..7397630ac 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualUnenrollManyParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualUnenrollManyParams.kt @@ -31,7 +31,10 @@ private constructor( fun benefitId(): String? = 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(): List? = entityIds /** @@ -93,7 +96,10 @@ private constructor( fun benefitId(benefitId: String?) = apply { this.benefitId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListParams.kt index 3a0af87bf..b22581ac7 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListParams.kt @@ -16,7 +16,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(): List? = entityIds /** Additional headers to send with the request. */ @@ -48,7 +51,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListSupportedBenefitsParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListSupportedBenefitsParams.kt index 0f1a3fe93..9249c8271 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListSupportedBenefitsParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitListSupportedBenefitsParams.kt @@ -16,7 +16,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(): List? = entityIds /** Additional headers to send with the request. */ @@ -54,7 +57,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRegisterParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRegisterParams.kt index 92627fe00..89addc13e 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRegisterParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRegisterParams.kt @@ -30,7 +30,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(): List? = entityIds /** @@ -111,7 +114,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRetrieveParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRetrieveParams.kt index 03180300c..a70bd48ee 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRetrieveParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitRetrieveParams.kt @@ -19,7 +19,10 @@ private constructor( fun benefitId(): String? = 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(): List? = entityIds /** Additional headers to send with the request. */ @@ -57,7 +60,10 @@ private constructor( fun benefitId(benefitId: String?) = apply { this.benefitId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitUpdateParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitUpdateParams.kt index 08ee937f2..007a162a7 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitUpdateParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitUpdateParams.kt @@ -30,7 +30,10 @@ private constructor( fun benefitId(): String? = 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(): List? = entityIds /** @@ -85,7 +88,10 @@ private constructor( fun benefitId(benefitId: String?) = apply { this.benefitId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisCompanyRetrieveParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisCompanyRetrieveParams.kt index 45579ac73..21d36ada4 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisCompanyRetrieveParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisCompanyRetrieveParams.kt @@ -16,7 +16,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(): List? = entityIds /** Additional headers to send with the request. */ @@ -50,7 +53,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListIndividualsParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListIndividualsParams.kt index da9343078..064c406b1 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListIndividualsParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListIndividualsParams.kt @@ -19,7 +19,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(): List? = entityIds /** Number of employees to return (defaults to 100, maximum 10000) */ @@ -66,7 +69,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListParams.kt index 8d6cc728c..79f281d00 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDirectoryListParams.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(): List? = entityIds /** Number of employees to return (defaults to 100, maximum 10000) */ @@ -60,7 +63,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentListParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentListParams.kt index 751f58608..630d71995 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentListParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentListParams.kt @@ -24,7 +24,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(): List? = entityIds /** @@ -79,7 +82,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentRetreiveParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentRetreiveParams.kt index 034f90b90..961c0033f 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentRetreiveParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisDocumentRetreiveParams.kt @@ -22,7 +22,10 @@ private constructor( fun documentId(): String? = 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(): List? = entityIds /** Additional headers to send with the request. */ @@ -60,7 +63,10 @@ private constructor( fun documentId(documentId: String?) = apply { this.documentId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisEmploymentRetrieveManyParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisEmploymentRetrieveManyParams.kt index 5586ecc4d..5c5f3213e 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisEmploymentRetrieveManyParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisEmploymentRetrieveManyParams.kt @@ -29,7 +29,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(): List? = entityIds /** @@ -88,7 +91,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisIndividualRetrieveManyParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisIndividualRetrieveManyParams.kt index 2c70f22f7..a16b265cb 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisIndividualRetrieveManyParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisIndividualRetrieveManyParams.kt @@ -29,7 +29,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(): List? = entityIds /** @@ -101,7 +104,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemListParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemListParams.kt index 8a0f832dc..58225439a 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemListParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemListParams.kt @@ -38,7 +38,10 @@ private constructor( */ fun endDate(): LocalDate? = 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(): List? = entityIds /** Case-insensitive partial match search by pay statement item name. */ @@ -118,7 +121,10 @@ private constructor( */ fun endDate(endDate: LocalDate?) = apply { this.endDate = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleCreateParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleCreateParams.kt index 3abbd340f..942cb321a 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleCreateParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleCreateParams.kt @@ -33,7 +33,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(): List? = entityIds /** @@ -150,7 +153,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleDeleteParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleDeleteParams.kt index 49fd39c73..2cea1a4d4 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleDeleteParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleDeleteParams.kt @@ -21,7 +21,10 @@ private constructor( fun ruleId(): String? = 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(): List? = entityIds /** Additional body properties to send with the request. */ @@ -69,7 +72,10 @@ private constructor( fun ruleId(ruleId: String?) = apply { this.ruleId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleListParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleListParams.kt index e346c9af5..9e028d2aa 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleListParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleListParams.kt @@ -16,7 +16,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(): List? = entityIds /** Additional headers to send with the request. */ @@ -53,7 +56,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleUpdateParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleUpdateParams.kt index d340909c2..48e6a986a 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleUpdateParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementItemRuleUpdateParams.kt @@ -29,7 +29,10 @@ private constructor( fun ruleId(): String? = 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(): List? = entityIds /** @@ -83,7 +86,10 @@ private constructor( fun ruleId(ruleId: String?) = apply { this.ruleId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() } diff --git a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementRetrieveManyParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementRetrieveManyParams.kt index 02a198f3b..314421a0d 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementRetrieveManyParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPayStatementRetrieveManyParams.kt @@ -33,7 +33,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(): List? = entityIds /** @@ -92,7 +95,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPaymentListParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPaymentListParams.kt index 0ef6a5785..0e346334b 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPaymentListParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/HrisPaymentListParams.kt @@ -32,7 +32,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(): List? = entityIds /** Additional headers to send with the request. */ @@ -86,7 +89,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/IndividualEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/IndividualEvent.kt index 7462c22e6..93c99a27c 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/IndividualEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/IndividualEvent.kt @@ -60,13 +60,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. @@ -111,10 +110,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]. @@ -210,11 +206,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)) /** @@ -224,7 +216,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/Introspection.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/Introspection.kt index 6724164e8..9920db7b8 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/Introspection.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/Introspection.kt @@ -202,13 +202,12 @@ private constructor( authenticationMethods.getNullable("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(): String? = companyId.getNullable("company_id") + fun companyId(): String? = companyId.getNullable("company_id") /** * The email of your customer you provided to Finch when a connect session was created for this @@ -362,10 +361,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]. @@ -666,11 +662,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)) /** @@ -680,7 +672,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/JobCompletionEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/JobCompletionEvent.kt index 23b69c1cb..641bfd761 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/JobCompletionEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/JobCompletionEvent.kt @@ -60,13 +60,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. @@ -111,10 +110,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]. @@ -210,11 +206,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)) /** @@ -224,7 +216,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayStatementEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayStatementEvent.kt index 70265849c..4da1e15d0 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayStatementEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayStatementEvent.kt @@ -60,13 +60,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. @@ -111,10 +110,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]. @@ -210,11 +206,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)) /** @@ -224,7 +216,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PaymentEvent.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PaymentEvent.kt index 275ae6a56..3ef2d5736 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PaymentEvent.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PaymentEvent.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]. @@ -212,11 +208,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)) /** @@ -226,7 +218,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupListParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupListParams.kt index b1c09035a..a4823fe5f 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupListParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupListParams.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(): List? = entityIds fun individualId(): String? = individualId @@ -60,7 +63,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-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupRetrieveParams.kt b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupRetrieveParams.kt index 149ad4c6b..8ad24275b 100644 --- a/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupRetrieveParams.kt +++ b/finch-kotlin-core/src/main/kotlin/com/tryfinch/api/models/PayrollPayGroupRetrieveParams.kt @@ -19,7 +19,10 @@ private constructor( fun payGroupId(): String? = 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(): List? = entityIds /** Additional headers to send with the request. */ @@ -58,7 +61,10 @@ private constructor( fun payGroupId(payGroupId: String?) = apply { this.payGroupId = 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(entityIds: List?) = apply { this.entityIds = entityIds?.toMutableList() }