Skip to content

Commit 3de68b0

Browse files
feat(api): api update
1 parent c4d3258 commit 3de68b0

16 files changed

Lines changed: 302 additions & 261 deletions

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 48
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-3cd1346947fabfca2aa9c6f821170c8d945a82667fb20a15644d5c77f8e98c10.yml
3-
openapi_spec_hash: 642e04e90d37c0e4875d154abd06eb54
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-a6b05e51c46366a54466c2009f5fdde74e0fa40bbcc6568601a4e3342dd16937.yml
3+
openapi_spec_hash: 084797c220144df17d98eb984dd4cba2
44
config_hash: 9ae56f40cec7304896138bfad5caf748

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ private constructor(
2424
/** The entity IDs to specify which entities' data to access. */
2525
fun entityIds(): Optional<List<String>> = Optional.ofNullable(entityIds)
2626

27-
/** Number of employees to return (defaults to all) */
27+
/** Number of employees to return (defaults to 100, maximum 10000) */
2828
fun limit(): Optional<Long> = Optional.ofNullable(limit)
2929

3030
/** Index to start from (defaults to 0) */
@@ -86,7 +86,7 @@ private constructor(
8686
entityIds = (entityIds ?: mutableListOf()).apply { add(entityId) }
8787
}
8888

89-
/** Number of employees to return (defaults to all) */
89+
/** Number of employees to return (defaults to 100, maximum 10000) */
9090
fun limit(limit: Long?) = apply { this.limit = limit }
9191

9292
/**

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ private constructor(
2323
/** The entity IDs to specify which entities' data to access. */
2424
fun entityIds(): Optional<List<String>> = Optional.ofNullable(entityIds)
2525

26-
/** Number of employees to return (defaults to all) */
26+
/** Number of employees to return (defaults to 100, maximum 10000) */
2727
fun limit(): Optional<Long> = Optional.ofNullable(limit)
2828

2929
/** Index to start from (defaults to 0) */
@@ -80,7 +80,7 @@ private constructor(
8080
entityIds = (entityIds ?: mutableListOf()).apply { add(entityId) }
8181
}
8282

83-
/** Number of employees to return (defaults to all) */
83+
/** Number of employees to return (defaults to 100, maximum 10000) */
8484
fun limit(limit: Long?) = apply { this.limit = limit }
8585

8686
/**

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

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ private constructor(
3535
fun entityIds(): Optional<List<String>> = Optional.ofNullable(entityIds)
3636

3737
/**
38-
* The array of batch requests.
38+
* The array of batch requests. Maximum 10000 items per request.
3939
*
4040
* @throws FinchInvalidDataException if the JSON field has an unexpected type or is unexpectedly
4141
* missing or null (e.g. if the server responded with an unexpected value).
@@ -117,7 +117,7 @@ private constructor(
117117
*/
118118
fun body(body: Body) = apply { this.body = body.toBuilder() }
119119

120-
/** The array of batch requests. */
120+
/** The array of batch requests. Maximum 10000 items per request. */
121121
fun requests(requests: List<Request>) = apply { body.requests(requests) }
122122

123123
/**
@@ -302,7 +302,7 @@ private constructor(
302302
) : this(requests, mutableMapOf())
303303

304304
/**
305-
* The array of batch requests.
305+
* The array of batch requests. Maximum 10000 items per request.
306306
*
307307
* @throws FinchInvalidDataException if the JSON field has an unexpected type or is
308308
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -355,7 +355,7 @@ private constructor(
355355
additionalProperties = body.additionalProperties.toMutableMap()
356356
}
357357

358-
/** The array of batch requests. */
358+
/** The array of batch requests. Maximum 10000 items per request. */
359359
fun requests(requests: List<Request>) = requests(JsonField.of(requests))
360360

361361
/**
@@ -490,9 +490,7 @@ private constructor(
490490
) : this(individualId, mutableMapOf())
491491

492492
/**
493-
* A stable Finch `id` (UUID v4) for an individual in the company. There is no limit to the
494-
* number of `individual_id` to send per request. It is preferantial to send all ids in a
495-
* single request for Finch to optimize provider rate-limits.
493+
* A stable Finch `id` (UUID v4) for an individual in the company.
496494
*
497495
* @throws FinchInvalidDataException if the JSON field has an unexpected type or is
498496
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -546,11 +544,7 @@ private constructor(
546544
additionalProperties = request.additionalProperties.toMutableMap()
547545
}
548546

549-
/**
550-
* A stable Finch `id` (UUID v4) for an individual in the company. There is no limit to
551-
* the number of `individual_id` to send per request. It is preferantial to send all ids
552-
* in a single request for Finch to optimize provider rate-limits.
553-
*/
547+
/** A stable Finch `id` (UUID v4) for an individual in the company. */
554548
fun individualId(individualId: String) = individualId(JsonField.of(individualId))
555549

556550
/**

0 commit comments

Comments
 (0)