feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 45
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-03a89ccdf10add981e714ad74c145cd3a2408bd0223108bbfe01cef4256ef7ed.yml
-openapi_spec_hash: 4179c69ca2f55a9fcfab41710a2f452c
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-0105d239fcaf84750c886dfa6c2cfbf2b2087f89a48f8827c4cbe28479ebfb13.yml
+openapi_spec_hash: 34895c3d3c137fb9f5a019ac5370afbb
 config_hash: 6d3585c0032e08d723d077d660fc8448

README.md

@@ -60,10 +60,7 @@ FinchClient client = FinchOkHttpClient.builder()
     .accessToken("My Access Token")
     .build();
 
-HrisDirectoryListParams params = HrisDirectoryListParams.builder()
-    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
-    .build();
-HrisDirectoryListPage page = client.hris().directory().list(params);
+HrisDirectoryListPage page = client.hris().directory().list();
 ```
 
 ## Client configuration
@@ -169,10 +166,7 @@ FinchClient client = FinchOkHttpClient.builder()
     .accessToken("My Access Token")
     .build();
 
-HrisDirectoryListParams params = HrisDirectoryListParams.builder()
-    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
-    .build();
-CompletableFuture<HrisDirectoryListPageAsync> page = client.async().hris().directory().list(params);
+CompletableFuture<HrisDirectoryListPageAsync> page = client.async().hris().directory().list();
 ```
 
 Or create an asynchronous client from the beginning:
@@ -191,10 +185,7 @@ FinchClientAsync client = FinchOkHttpClientAsync.builder()
     .accessToken("My Access Token")
     .build();
 
-HrisDirectoryListParams params = HrisDirectoryListParams.builder()
-    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
-    .build();
-CompletableFuture<HrisDirectoryListPageAsync> page = client.hris().directory().list(params);
+CompletableFuture<HrisDirectoryListPageAsync> page = client.hris().directory().list();
 ```
 
 The asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.
@@ -211,10 +202,7 @@ import com.tryfinch.api.core.http.HttpResponseFor;
 import com.tryfinch.api.models.HrisDirectoryListPage;
 import com.tryfinch.api.models.HrisDirectoryListParams;
 
-HrisDirectoryListParams params = HrisDirectoryListParams.builder()
-    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
-    .build();
-HttpResponseFor<HrisDirectoryListPage> page = client.hris().directory().withRawResponse().list(params);
+HttpResponseFor<HrisDirectoryListPage> page = client.hris().directory().withRawResponse().list();
 
 int statusCode = page.statusCode();
 Headers headers = page.headers();
@@ -267,7 +255,7 @@ When using the synchronous client, the method returns an [`Iterable`](https://do
 import com.tryfinch.api.models.HrisDirectoryListPage;
 import com.tryfinch.api.models.IndividualInDirectory;
 
-HrisDirectoryListPage page = client.hris().directory().list(params);
+HrisDirectoryListPage page = client.hris().directory().list();
 
 // Process as an Iterable
 for (IndividualInDirectory directory : page.autoPager()) {
@@ -290,7 +278,7 @@ import com.tryfinch.api.models.IndividualInDirectory;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 
-CompletableFuture<HrisDirectoryListPageAsync> pageFuture = client.async().hris().directory().list(params);
+CompletableFuture<HrisDirectoryListPageAsync> pageFuture = client.async().hris().directory().list();
 
 pageFuture.thenRun(page -> page.autoPager().subscribe(directory -> {
     System.out.println(directory);
@@ -339,7 +327,7 @@ To access individual page items and manually request the next page, use the `ite
 import com.tryfinch.api.models.HrisDirectoryListPage;
 import com.tryfinch.api.models.IndividualInDirectory;
 
-HrisDirectoryListPage page = client.hris().directory().list(params);
+HrisDirectoryListPage page = client.hris().directory().list();
 while (true) {
     for (IndividualInDirectory directory : page.items()) {
         System.out.println(directory);
@@ -434,9 +422,7 @@ To set a custom timeout, configure the method call using the `timeout` method:
 ```java
 import com.tryfinch.api.models.HrisDirectoryListPage;
 
-HrisDirectoryListPage page = client.hris().directory().list(
-  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
-);
+HrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());
 ```
 
 Or configure the default for all method calls at the client level:
@@ -558,9 +544,7 @@ To set a documented parameter or property to an undocumented or not yet supporte
 ```java
 import com.tryfinch.api.models.HrisDirectoryListParams;
 
-HrisDirectoryListParams params = HrisDirectoryListParams.builder()
-    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
-    .build();
+HrisDirectoryListParams params = HrisDirectoryListParams.builder().build();
 ```
 
 The most straightforward way to create a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:
@@ -608,10 +592,11 @@ To forcibly omit a required parameter or property, pass [`JsonMissing`](finch-ja
 
 ```java
 import com.tryfinch.api.core.JsonMissing;
+import com.tryfinch.api.models.AccessTokenCreateParams;
 import com.tryfinch.api.models.HrisDirectoryListParams;
 
-HrisDirectoryListParams params = HrisDirectoryListParams.builder()
-    .entityIds(JsonMissing.of())
+HrisDirectoryListParams params = AccessTokenCreateParams.builder()
+    .code(JsonMissing.of())
     .build();
 ```
 
@@ -688,9 +673,7 @@ Or configure the method call to validate the response using the `responseValidat
 ```java
 import com.tryfinch.api.models.HrisDirectoryListPage;
 
-HrisDirectoryListPage page = client.hris().directory().list(
-  params, RequestOptions.builder().responseValidation(true).build()
-);
+HrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build());
 ```
 
 Or configure the default for all method calls at the client level:

finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitCreateParams.kt

@@ -29,14 +29,14 @@ import kotlin.jvm.optionals.getOrNull
  */
 class HrisBenefitCreateParams
 private constructor(
-    private val entityIds: List<String>,
+    private val entityIds: List<String>?,
     private val body: Body,
     private val additionalHeaders: Headers,
     private val additionalQueryParams: QueryParams,
 ) : Params {
 
     /** The entity IDs to specify which entities' data to access. */
-    fun entityIds(): List<String> = entityIds
+    fun entityIds(): Optional<List<String>> = Optional.ofNullable(entityIds)
 
     /**
      * The company match for this benefit.
@@ -114,14 +114,9 @@ private constructor(
 
     companion object {
 
-        /**
-         * Returns a mutable builder for constructing an instance of [HrisBenefitCreateParams].
-         *
-         * The following fields are required:
-         * ```java
-         * .entityIds()
-         * ```
-         */
+        @JvmStatic fun none(): HrisBenefitCreateParams = builder().build()
+
+        /** Returns a mutable builder for constructing an instance of [HrisBenefitCreateParams]. */
         @JvmStatic fun builder() = Builder()
     }
 
@@ -135,17 +130,20 @@ private constructor(
 
         @JvmSynthetic
         internal fun from(hrisBenefitCreateParams: HrisBenefitCreateParams) = apply {
-            entityIds = hrisBenefitCreateParams.entityIds.toMutableList()
+            entityIds = hrisBenefitCreateParams.entityIds?.toMutableList()
             body = hrisBenefitCreateParams.body.toBuilder()
             additionalHeaders = hrisBenefitCreateParams.additionalHeaders.toBuilder()
             additionalQueryParams = hrisBenefitCreateParams.additionalQueryParams.toBuilder()
         }
 
         /** The entity IDs to specify which entities' data to access. */
-        fun entityIds(entityIds: List<String>) = apply {
-            this.entityIds = entityIds.toMutableList()
+        fun entityIds(entityIds: List<String>?) = apply {
+            this.entityIds = entityIds?.toMutableList()
         }
 
+        /** Alias for calling [Builder.entityIds] with `entityIds.orElse(null)`. */
+        fun entityIds(entityIds: Optional<List<String>>) = entityIds(entityIds.getOrNull())
+
         /**
          * Adds a single [String] to [entityIds].
          *
@@ -356,17 +354,10 @@ private constructor(
          * Returns an immutable instance of [HrisBenefitCreateParams].
          *
          * Further updates to this [Builder] will not mutate the returned instance.
-         *
-         * The following fields are required:
-         * ```java
-         * .entityIds()
-         * ```
-         *
-         * @throws IllegalStateException if any required field is unset.
          */
         fun build(): HrisBenefitCreateParams =
             HrisBenefitCreateParams(
-                checkRequired("entityIds", entityIds).toImmutable(),
+                entityIds?.toImmutable(),
                 body.build(),
                 additionalHeaders.build(),
                 additionalQueryParams.build(),
@@ -380,7 +371,7 @@ private constructor(
     override fun _queryParams(): QueryParams =
         QueryParams.builder()
             .apply {
-                entityIds.forEach { put("entity_ids[]", it) }
+                entityIds?.forEach { put("entity_ids[]", it) }
                 putAll(additionalQueryParams)
             }
             .build()

finch-java-core/src/main/kotlin/com/tryfinch/api/models/HrisBenefitIndividualEnrolledIdsParams.kt

@@ -3,7 +3,6 @@
 package com.tryfinch.api.models
 
 import com.tryfinch.api.core.Params
-import com.tryfinch.api.core.checkRequired
 import com.tryfinch.api.core.http.Headers
 import com.tryfinch.api.core.http.QueryParams
 import com.tryfinch.api.core.toImmutable
@@ -15,15 +14,15 @@ import kotlin.jvm.optionals.getOrNull
 class HrisBenefitIndividualEnrolledIdsParams
 private constructor(
     private val benefitId: String?,
-    private val entityIds: List<String>,
+    private val entityIds: List<String>?,
     private val additionalHeaders: Headers,
     private val additionalQueryParams: QueryParams,
 ) : Params {
 
     fun benefitId(): Optional<String> = Optional.ofNullable(benefitId)
 
     /** The entity IDs to specify which entities' data to access. */
-    fun entityIds(): List<String> = entityIds
+    fun entityIds(): Optional<List<String>> = Optional.ofNullable(entityIds)
 
     /** Additional headers to send with the request. */
     fun _additionalHeaders(): Headers = additionalHeaders
@@ -35,14 +34,11 @@ private constructor(
 
     companion object {
 
+        @JvmStatic fun none(): HrisBenefitIndividualEnrolledIdsParams = builder().build()
+
         /**
          * Returns a mutable builder for constructing an instance of
          * [HrisBenefitIndividualEnrolledIdsParams].
-         *
-         * The following fields are required:
-         * ```java
-         * .entityIds()
-         * ```
          */
         @JvmStatic fun builder() = Builder()
     }
@@ -60,7 +56,7 @@ private constructor(
             hrisBenefitIndividualEnrolledIdsParams: HrisBenefitIndividualEnrolledIdsParams
         ) = apply {
             benefitId = hrisBenefitIndividualEnrolledIdsParams.benefitId
-            entityIds = hrisBenefitIndividualEnrolledIdsParams.entityIds.toMutableList()
+            entityIds = hrisBenefitIndividualEnrolledIdsParams.entityIds?.toMutableList()
             additionalHeaders = hrisBenefitIndividualEnrolledIdsParams.additionalHeaders.toBuilder()
             additionalQueryParams =
                 hrisBenefitIndividualEnrolledIdsParams.additionalQueryParams.toBuilder()
@@ -72,10 +68,13 @@ private constructor(
         fun benefitId(benefitId: Optional<String>) = benefitId(benefitId.getOrNull())
 
         /** The entity IDs to specify which entities' data to access. */
-        fun entityIds(entityIds: List<String>) = apply {
-            this.entityIds = entityIds.toMutableList()
+        fun entityIds(entityIds: List<String>?) = apply {
+            this.entityIds = entityIds?.toMutableList()
         }
 
+        /** Alias for calling [Builder.entityIds] with `entityIds.orElse(null)`. */
+        fun entityIds(entityIds: Optional<List<String>>) = entityIds(entityIds.getOrNull())
+
         /**
          * Adds a single [String] to [entityIds].
          *
@@ -187,18 +186,11 @@ private constructor(
          * Returns an immutable instance of [HrisBenefitIndividualEnrolledIdsParams].
          *
          * Further updates to this [Builder] will not mutate the returned instance.
-         *
-         * The following fields are required:
-         * ```java
-         * .entityIds()
-         * ```
-         *
-         * @throws IllegalStateException if any required field is unset.
          */
         fun build(): HrisBenefitIndividualEnrolledIdsParams =
             HrisBenefitIndividualEnrolledIdsParams(
                 benefitId,
-                checkRequired("entityIds", entityIds).toImmutable(),
+                entityIds?.toImmutable(),
                 additionalHeaders.build(),
                 additionalQueryParams.build(),
             )
@@ -215,7 +207,7 @@ private constructor(
     override fun _queryParams(): QueryParams =
         QueryParams.builder()
             .apply {
-                entityIds.forEach { put("entity_ids[]", it) }
+                entityIds?.forEach { put("entity_ids[]", it) }
                 putAll(additionalQueryParams)
             }
             .build()