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-9c32d7e477bd1c441abd65db0dfe6220948aa00face05fc8b57395e368ee2099.yml
-openapi_spec_hash: 3da940ffc5da8000a4f359c958ed341f
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-03a89ccdf10add981e714ad74c145cd3a2408bd0223108bbfe01cef4256ef7ed.yml
+openapi_spec_hash: 4179c69ca2f55a9fcfab41710a2f452c
 config_hash: 6d3585c0032e08d723d077d660fc8448

README.md

@@ -60,7 +60,10 @@ FinchClient client = FinchOkHttpClient.builder()
     .accessToken("My Access Token")
     .build();
 
-HrisDirectoryListPage page = client.hris().directory().list();
+HrisDirectoryListParams params = HrisDirectoryListParams.builder()
+    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
+    .build();
+HrisDirectoryListPage page = client.hris().directory().list(params);
 ```
 
 ## Client configuration
@@ -166,7 +169,10 @@ FinchClient client = FinchOkHttpClient.builder()
     .accessToken("My Access Token")
     .build();
 
-CompletableFuture<HrisDirectoryListPageAsync> page = client.async().hris().directory().list();
+HrisDirectoryListParams params = HrisDirectoryListParams.builder()
+    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
+    .build();
+CompletableFuture<HrisDirectoryListPageAsync> page = client.async().hris().directory().list(params);
 ```
 
 Or create an asynchronous client from the beginning:
@@ -185,7 +191,10 @@ FinchClientAsync client = FinchOkHttpClientAsync.builder()
     .accessToken("My Access Token")
     .build();
 
-CompletableFuture<HrisDirectoryListPageAsync> page = client.hris().directory().list();
+HrisDirectoryListParams params = HrisDirectoryListParams.builder()
+    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
+    .build();
+CompletableFuture<HrisDirectoryListPageAsync> page = client.hris().directory().list(params);
 ```
 
 The asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.
@@ -202,7 +211,10 @@ import com.tryfinch.api.core.http.HttpResponseFor;
 import com.tryfinch.api.models.HrisDirectoryListPage;
 import com.tryfinch.api.models.HrisDirectoryListParams;
 
-HttpResponseFor<HrisDirectoryListPage> page = client.hris().directory().withRawResponse().list();
+HrisDirectoryListParams params = HrisDirectoryListParams.builder()
+    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
+    .build();
+HttpResponseFor<HrisDirectoryListPage> page = client.hris().directory().withRawResponse().list(params);
 
 int statusCode = page.statusCode();
 Headers headers = page.headers();
@@ -255,7 +267,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();
+HrisDirectoryListPage page = client.hris().directory().list(params);
 
 // Process as an Iterable
 for (IndividualInDirectory directory : page.autoPager()) {
@@ -278,7 +290,7 @@ import com.tryfinch.api.models.IndividualInDirectory;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 
-CompletableFuture<HrisDirectoryListPageAsync> pageFuture = client.async().hris().directory().list();
+CompletableFuture<HrisDirectoryListPageAsync> pageFuture = client.async().hris().directory().list(params);
 
 pageFuture.thenRun(page -> page.autoPager().subscribe(directory -> {
     System.out.println(directory);
@@ -327,7 +339,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();
+HrisDirectoryListPage page = client.hris().directory().list(params);
 while (true) {
     for (IndividualInDirectory directory : page.items()) {
         System.out.println(directory);
@@ -422,7 +434,9 @@ 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(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());
+HrisDirectoryListPage page = client.hris().directory().list(
+  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
+);
 ```
 
 Or configure the default for all method calls at the client level:
@@ -544,7 +558,9 @@ 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().build();
+HrisDirectoryListParams params = HrisDirectoryListParams.builder()
+    .addEntityId("550e8400-e29b-41d4-a716-446655440000")
+    .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:
@@ -592,11 +608,10 @@ 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 = AccessTokenCreateParams.builder()
-    .code(JsonMissing.of())
+HrisDirectoryListParams params = HrisDirectoryListParams.builder()
+    .entityIds(JsonMissing.of())
     .build();
 ```
 
@@ -673,7 +688,9 @@ 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(RequestOptions.builder().responseValidation(true).build());
+HrisDirectoryListPage page = client.hris().directory().list(
+  params, 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/CreateAccessTokenResponse.kt

@@ -27,6 +27,7 @@ private constructor(
     private val clientType: JsonField<ClientType>,
     private val connectionId: JsonField<String>,
     private val connectionType: JsonField<ConnectionType>,
+    private val entityIds: JsonField<List<String>>,
     private val products: JsonField<List<String>>,
     private val providerId: JsonField<String>,
     private val tokenType: JsonField<String>,
@@ -50,6 +51,9 @@ private constructor(
         @JsonProperty("connection_type")
         @ExcludeMissing
         connectionType: JsonField<ConnectionType> = JsonMissing.of(),
+        @JsonProperty("entity_ids")
+        @ExcludeMissing
+        entityIds: JsonField<List<String>> = JsonMissing.of(),
         @JsonProperty("products")
         @ExcludeMissing
         products: JsonField<List<String>> = JsonMissing.of(),
@@ -67,6 +71,7 @@ private constructor(
         clientType,
         connectionId,
         connectionType,
+        entityIds,
         products,
         providerId,
         tokenType,
@@ -110,6 +115,14 @@ private constructor(
      */
     fun connectionType(): ConnectionType = connectionType.getRequired("connection_type")
 
+    /**
+     * An array of entity IDs that can be accessed with this 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).
+     */
+    fun entityIds(): List<String> = entityIds.getRequired("entity_ids")
+
     /**
      * An array of the authorized products associated with the `access_token`
      *
@@ -197,6 +210,15 @@ private constructor(
     @ExcludeMissing
     fun _connectionType(): JsonField<ConnectionType> = connectionType
 
+    /**
+     * Returns the raw JSON value of [entityIds].
+     *
+     * Unlike [entityIds], this method doesn't throw if the JSON field has an unexpected type.
+     */
+    @JsonProperty("entity_ids")
+    @ExcludeMissing
+    fun _entityIds(): JsonField<List<String>> = entityIds
+
     /**
      * Returns the raw JSON value of [products].
      *
@@ -268,6 +290,7 @@ private constructor(
          * .clientType()
          * .connectionId()
          * .connectionType()
+         * .entityIds()
          * .products()
          * .providerId()
          * .tokenType()
@@ -283,6 +306,7 @@ private constructor(
         private var clientType: JsonField<ClientType>? = null
         private var connectionId: JsonField<String>? = null
         private var connectionType: JsonField<ConnectionType>? = null
+        private var entityIds: JsonField<MutableList<String>>? = null
         private var products: JsonField<MutableList<String>>? = null
         private var providerId: JsonField<String>? = null
         private var tokenType: JsonField<String>? = null
@@ -297,6 +321,7 @@ private constructor(
             clientType = createAccessTokenResponse.clientType
             connectionId = createAccessTokenResponse.connectionId
             connectionType = createAccessTokenResponse.connectionType
+            entityIds = createAccessTokenResponse.entityIds.map { it.toMutableList() }
             products = createAccessTokenResponse.products.map { it.toMutableList() }
             providerId = createAccessTokenResponse.providerId
             tokenType = createAccessTokenResponse.tokenType
@@ -363,6 +388,32 @@ private constructor(
             this.connectionType = connectionType
         }
 
+        /** An array of entity IDs that can be accessed with this access token */
+        fun entityIds(entityIds: List<String>) = entityIds(JsonField.of(entityIds))
+
+        /**
+         * Sets [Builder.entityIds] to an arbitrary JSON value.
+         *
+         * You should usually call [Builder.entityIds] with a well-typed `List<String>` value
+         * instead. This method is primarily for setting the field to an undocumented or not yet
+         * supported value.
+         */
+        fun entityIds(entityIds: JsonField<List<String>>) = apply {
+            this.entityIds = entityIds.map { it.toMutableList() }
+        }
+
+        /**
+         * Adds a single [String] to [entityIds].
+         *
+         * @throws IllegalStateException if the field was previously set to a non-list.
+         */
+        fun addEntityId(entityId: String) = apply {
+            entityIds =
+                (entityIds ?: JsonField.of(mutableListOf())).also {
+                    checkKnown("entityIds", it).add(entityId)
+                }
+        }
+
         /** An array of the authorized products associated with the `access_token` */
         fun products(products: List<String>) = products(JsonField.of(products))
 
@@ -493,6 +544,7 @@ private constructor(
          * .clientType()
          * .connectionId()
          * .connectionType()
+         * .entityIds()
          * .products()
          * .providerId()
          * .tokenType()
@@ -506,6 +558,7 @@ private constructor(
                 checkRequired("clientType", clientType),
                 checkRequired("connectionId", connectionId),
                 checkRequired("connectionType", connectionType),
+                checkRequired("entityIds", entityIds).map { it.toImmutable() },
                 checkRequired("products", products).map { it.toImmutable() },
                 checkRequired("providerId", providerId),
                 checkRequired("tokenType", tokenType),
@@ -527,6 +580,7 @@ private constructor(
         clientType().validate()
         connectionId()
         connectionType().validate()
+        entityIds()
         products()
         providerId()
         tokenType()
@@ -555,6 +609,7 @@ private constructor(
             (clientType.asKnown().getOrNull()?.validity() ?: 0) +
             (if (connectionId.asKnown().isPresent) 1 else 0) +
             (connectionType.asKnown().getOrNull()?.validity() ?: 0) +
+            (entityIds.asKnown().getOrNull()?.size ?: 0) +
             (products.asKnown().getOrNull()?.size ?: 0) +
             (if (providerId.asKnown().isPresent) 1 else 0) +
             (if (tokenType.asKnown().isPresent) 1 else 0) +
@@ -838,6 +893,7 @@ private constructor(
             clientType == other.clientType &&
             connectionId == other.connectionId &&
             connectionType == other.connectionType &&
+            entityIds == other.entityIds &&
             products == other.products &&
             providerId == other.providerId &&
             tokenType == other.tokenType &&
@@ -853,6 +909,7 @@ private constructor(
             clientType,
             connectionId,
             connectionType,
+            entityIds,
             products,
             providerId,
             tokenType,
@@ -866,5 +923,5 @@ private constructor(
     override fun hashCode(): Int = hashCode
 
     override fun toString() =
-        "CreateAccessTokenResponse{accessToken=$accessToken, clientType=$clientType, connectionId=$connectionId, connectionType=$connectionType, products=$products, providerId=$providerId, tokenType=$tokenType, accountId=$accountId, companyId=$companyId, customerId=$customerId, additionalProperties=$additionalProperties}"
+        "CreateAccessTokenResponse{accessToken=$accessToken, clientType=$clientType, connectionId=$connectionId, connectionType=$connectionType, entityIds=$entityIds, products=$products, providerId=$providerId, tokenType=$tokenType, accountId=$accountId, companyId=$companyId, customerId=$customerId, additionalProperties=$additionalProperties}"
 }