Skip to content

Commit f10523a

Browse files
stainless-app[bot]stainless-bot
authored andcommitted
docs: clarify behavior around employee_size (#363)
1 parent 5f9f330 commit f10523a

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

src/finch/resources/sandbox/connections/connections.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ def create(
6565
6666
Args:
6767
employee_size: Optional: the size of the employer to be created with this connection. Defaults
68-
to 20
68+
to 20. Note that if this is higher than 100, historical payroll data will not be
69+
generated, and instead only one pay period will be created.
6970
7071
extra_headers: Send extra headers
7172
@@ -125,7 +126,8 @@ async def create(
125126
126127
Args:
127128
employee_size: Optional: the size of the employer to be created with this connection. Defaults
128-
to 20
129+
to 20. Note that if this is higher than 100, historical payroll data will not be
130+
generated, and instead only one pay period will be created.
129131
130132
extra_headers: Send extra headers
131133

src/finch/types/sandbox/connection_create_params.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ class ConnectionCreateParams(TypedDict, total=False):
1616
employee_size: int
1717
"""Optional: the size of the employer to be created with this connection.
1818
19-
Defaults to 20
19+
Defaults to 20. Note that if this is higher than 100, historical payroll data
20+
will not be generated, and instead only one pay period will be created.
2021
"""
2122

2223
products: List[str]

0 commit comments

Comments
 (0)