Skip to content

Commit 831b170

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent 93a72d4 commit 831b170

File tree

59 files changed

+1214
-215
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+1214
-215
lines changed

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 46
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-9c32d7e477bd1c441abd65db0dfe6220948aa00face05fc8b57395e368ee2099.yml
3-
openapi_spec_hash: 3da940ffc5da8000a4f359c958ed341f
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-03a89ccdf10add981e714ad74c145cd3a2408bd0223108bbfe01cef4256ef7ed.yml
3+
openapi_spec_hash: 4179c69ca2f55a9fcfab41710a2f452c
44
config_hash: 6d3585c0032e08d723d077d660fc8448

‎README.md‎

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ client = Finch(
3131
access_token="My Access Token",
3232
)
3333

34-
page = client.hris.directory.list()
34+
page = client.hris.directory.list(
35+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
36+
)
3537
print(page.individuals)
3638
```
3739

@@ -49,7 +51,9 @@ client = AsyncFinch(
4951

5052

5153
async def main() -> None:
52-
page = await client.hris.directory.list()
54+
page = await client.hris.directory.list(
55+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
56+
)
5357
print(page.individuals)
5458

5559

@@ -82,7 +86,9 @@ async def main() -> None:
8286
access_token="My Access Token",
8387
http_client=DefaultAioHttpClient(),
8488
) as client:
85-
page = await client.hris.directory.list()
89+
page = await client.hris.directory.list(
90+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
91+
)
8692
print(page.individuals)
8793

8894

@@ -111,7 +117,9 @@ client = Finch()
111117

112118
all_directories = []
113119
# Automatically fetches more pages as needed.
114-
for directory in client.hris.directory.list():
120+
for directory in client.hris.directory.list(
121+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
122+
):
115123
# Do something with directory here
116124
all_directories.append(directory)
117125
print(all_directories)
@@ -129,7 +137,9 @@ client = AsyncFinch()
129137
async def main() -> None:
130138
all_directories = []
131139
# Iterate through items across all pages, issuing requests as needed.
132-
async for directory in client.hris.directory.list():
140+
async for directory in client.hris.directory.list(
141+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
142+
):
133143
all_directories.append(directory)
134144
print(all_directories)
135145

@@ -140,7 +150,9 @@ asyncio.run(main())
140150
Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
141151

142152
```python
143-
first_page = await client.hris.directory.list()
153+
first_page = await client.hris.directory.list(
154+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
155+
)
144156
if first_page.has_next_page():
145157
print(f"will fetch next page using these details: {first_page.next_page_info()}")
146158
next_page = await first_page.get_next_page()
@@ -152,7 +164,9 @@ if first_page.has_next_page():
152164
Or just work directly with the returned data:
153165

154166
```python
155-
first_page = await client.hris.directory.list()
167+
first_page = await client.hris.directory.list(
168+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
169+
)
156170

157171
print(
158172
f"the current start offset for this page: {first_page.paging.offset}"
@@ -202,7 +216,9 @@ from finch import Finch
202216
client = Finch()
203217

204218
try:
205-
client.hris.company.retrieve()
219+
client.hris.company.retrieve(
220+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
221+
)
206222
except finch.APIConnectionError as e:
207223
print("The server could not be reached")
208224
print(e.__cause__) # an underlying Exception, likely raised within httpx.
@@ -245,7 +261,9 @@ client = Finch(
245261
)
246262

247263
# Or, configure per-request:
248-
client.with_options(max_retries=5).hris.directory.list()
264+
client.with_options(max_retries=5).hris.directory.list(
265+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
266+
)
249267
```
250268

251269
### Timeouts
@@ -268,7 +286,9 @@ client = Finch(
268286
)
269287

270288
# Override per-request:
271-
client.with_options(timeout=5.0).hris.directory.list()
289+
client.with_options(timeout=5.0).hris.directory.list(
290+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
291+
)
272292
```
273293

274294
On timeout, an `APITimeoutError` is thrown.
@@ -325,7 +345,9 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
325345
from finch import Finch
326346

327347
client = Finch()
328-
response = client.hris.directory.with_raw_response.list()
348+
response = client.hris.directory.with_raw_response.list(
349+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
350+
)
329351
print(response.headers.get('X-My-Header'))
330352

331353
directory = response.parse() # get the object that `hris.directory.list()` would have returned
@@ -350,7 +372,9 @@ To stream the response body, use `.with_streaming_response` instead, which requi
350372
As such, `.with_streaming_response` methods return a different [`APIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object, and the async client returns an [`AsyncAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object.
351373

352374
```python
353-
with client.hris.directory.with_streaming_response.list() as response:
375+
with client.hris.directory.with_streaming_response.list(
376+
entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
377+
) as response:
354378
print(response.headers.get("X-My-Header"))
355379

356380
for line in response.iter_lines():

‎api.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ from finch.types.hris import Company
4141

4242
Methods:
4343

44-
- <code title="get /employer/company">client.hris.company.<a href="./src/finch/resources/hris/company/company.py">retrieve</a>() -> <a href="./src/finch/types/hris/company/company.py">Company</a></code>
44+
- <code title="get /employer/company">client.hris.company.<a href="./src/finch/resources/hris/company/company.py">retrieve</a>(\*\*<a href="src/finch/types/hris/company_retrieve_params.py">params</a>) -> <a href="./src/finch/types/hris/company/company.py">Company</a></code>
4545

4646
### PayStatementItem
4747

@@ -72,8 +72,8 @@ Methods:
7272

7373
- <code title="post /employer/pay-statement-item/rule">client.hris.company.pay_statement_item.rules.<a href="./src/finch/resources/hris/company/pay_statement_item/rules.py">create</a>(\*\*<a href="src/finch/types/hris/company/pay_statement_item/rule_create_params.py">params</a>) -> <a href="./src/finch/types/hris/company/pay_statement_item/rule_create_response.py">RuleCreateResponse</a></code>
7474
- <code title="put /employer/pay-statement-item/rule/{rule_id}">client.hris.company.pay_statement_item.rules.<a href="./src/finch/resources/hris/company/pay_statement_item/rules.py">update</a>(rule_id, \*\*<a href="src/finch/types/hris/company/pay_statement_item/rule_update_params.py">params</a>) -> <a href="./src/finch/types/hris/company/pay_statement_item/rule_update_response.py">RuleUpdateResponse</a></code>
75-
- <code title="get /employer/pay-statement-item/rule">client.hris.company.pay_statement_item.rules.<a href="./src/finch/resources/hris/company/pay_statement_item/rules.py">list</a>() -> <a href="./src/finch/types/hris/company/pay_statement_item/rule_list_response.py">SyncResponsesPage[RuleListResponse]</a></code>
76-
- <code title="delete /employer/pay-statement-item/rule/{rule_id}">client.hris.company.pay_statement_item.rules.<a href="./src/finch/resources/hris/company/pay_statement_item/rules.py">delete</a>(rule_id) -> <a href="./src/finch/types/hris/company/pay_statement_item/rule_delete_response.py">RuleDeleteResponse</a></code>
75+
- <code title="get /employer/pay-statement-item/rule">client.hris.company.pay_statement_item.rules.<a href="./src/finch/resources/hris/company/pay_statement_item/rules.py">list</a>(\*\*<a href="src/finch/types/hris/company/pay_statement_item/rule_list_params.py">params</a>) -> <a href="./src/finch/types/hris/company/pay_statement_item/rule_list_response.py">SyncResponsesPage[RuleListResponse]</a></code>
76+
- <code title="delete /employer/pay-statement-item/rule/{rule_id}">client.hris.company.pay_statement_item.rules.<a href="./src/finch/resources/hris/company/pay_statement_item/rules.py">delete</a>(rule_id, \*\*<a href="src/finch/types/hris/company/pay_statement_item/rule_delete_params.py">params</a>) -> <a href="./src/finch/types/hris/company/pay_statement_item/rule_delete_response.py">RuleDeleteResponse</a></code>
7777

7878
## Directory
7979

@@ -157,7 +157,7 @@ from finch.types.hris import (
157157
Methods:
158158

159159
- <code title="get /employer/documents">client.hris.documents.<a href="./src/finch/resources/hris/documents.py">list</a>(\*\*<a href="src/finch/types/hris/document_list_params.py">params</a>) -> <a href="./src/finch/types/hris/document_list_response.py">DocumentListResponse</a></code>
160-
- <code title="get /employer/documents/{document_id}">client.hris.documents.<a href="./src/finch/resources/hris/documents.py">retreive</a>(document_id) -> <a href="./src/finch/types/hris/document_retreive_response.py">DocumentRetreiveResponse</a></code>
160+
- <code title="get /employer/documents/{document_id}">client.hris.documents.<a href="./src/finch/resources/hris/documents.py">retreive</a>(document_id, \*\*<a href="src/finch/types/hris/document_retreive_params.py">params</a>) -> <a href="./src/finch/types/hris/document_retreive_response.py">DocumentRetreiveResponse</a></code>
161161

162162
## Benefits
163163

@@ -182,10 +182,10 @@ from finch.types.hris import (
182182
Methods:
183183

184184
- <code title="post /employer/benefits">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">create</a>(\*\*<a href="src/finch/types/hris/benefit_create_params.py">params</a>) -> <a href="./src/finch/types/hris/create_company_benefits_response.py">CreateCompanyBenefitsResponse</a></code>
185-
- <code title="get /employer/benefits/{benefit_id}">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">retrieve</a>(benefit_id) -> <a href="./src/finch/types/hris/company_benefit.py">CompanyBenefit</a></code>
185+
- <code title="get /employer/benefits/{benefit_id}">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">retrieve</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefit_retrieve_params.py">params</a>) -> <a href="./src/finch/types/hris/company_benefit.py">CompanyBenefit</a></code>
186186
- <code title="post /employer/benefits/{benefit_id}">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">update</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefit_update_params.py">params</a>) -> <a href="./src/finch/types/hris/update_company_benefit_response.py">UpdateCompanyBenefitResponse</a></code>
187-
- <code title="get /employer/benefits">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">list</a>() -> <a href="./src/finch/types/hris/company_benefit.py">SyncSinglePage[CompanyBenefit]</a></code>
188-
- <code title="get /employer/benefits/meta">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">list_supported_benefits</a>() -> <a href="./src/finch/types/hris/supported_benefit.py">SyncSinglePage[SupportedBenefit]</a></code>
187+
- <code title="get /employer/benefits">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">list</a>(\*\*<a href="src/finch/types/hris/benefit_list_params.py">params</a>) -> <a href="./src/finch/types/hris/company_benefit.py">SyncSinglePage[CompanyBenefit]</a></code>
188+
- <code title="get /employer/benefits/meta">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">list_supported_benefits</a>(\*\*<a href="src/finch/types/hris/benefit_list_supported_benefits_params.py">params</a>) -> <a href="./src/finch/types/hris/supported_benefit.py">SyncSinglePage[SupportedBenefit]</a></code>
189189

190190
### Individuals
191191

@@ -203,7 +203,7 @@ from finch.types.hris.benefits import (
203203
Methods:
204204

205205
- <code title="post /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">enroll_many</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefits/individual_enroll_many_params.py">params</a>) -> <a href="./src/finch/types/hris/benefits/enrolled_individual_benefit_response.py">EnrolledIndividualBenefitResponse</a></code>
206-
- <code title="get /employer/benefits/{benefit_id}/enrolled">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">enrolled_ids</a>(benefit_id) -> <a href="./src/finch/types/hris/benefits/individual_enrolled_ids_response.py">IndividualEnrolledIDsResponse</a></code>
206+
- <code title="get /employer/benefits/{benefit_id}/enrolled">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">enrolled_ids</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefits/individual_enrolled_ids_params.py">params</a>) -> <a href="./src/finch/types/hris/benefits/individual_enrolled_ids_response.py">IndividualEnrolledIDsResponse</a></code>
207207
- <code title="get /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">retrieve_many_benefits</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefits/individual_retrieve_many_benefits_params.py">params</a>) -> <a href="./src/finch/types/hris/benefits/individual_benefit.py">SyncSinglePage[IndividualBenefit]</a></code>
208208
- <code title="delete /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">unenroll_many</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefits/individual_unenroll_many_params.py">params</a>) -> <a href="./src/finch/types/hris/benefits/unenrolled_individual_benefit_response.py">UnenrolledIndividualBenefitResponse</a></code>
209209

@@ -420,7 +420,7 @@ from finch.types.payroll import PayGroupRetrieveResponse, PayGroupListResponse
420420

421421
Methods:
422422

423-
- <code title="get /employer/pay-groups/{pay_group_id}">client.payroll.pay_groups.<a href="./src/finch/resources/payroll/pay_groups.py">retrieve</a>(pay_group_id) -> <a href="./src/finch/types/payroll/pay_group_retrieve_response.py">PayGroupRetrieveResponse</a></code>
423+
- <code title="get /employer/pay-groups/{pay_group_id}">client.payroll.pay_groups.<a href="./src/finch/resources/payroll/pay_groups.py">retrieve</a>(pay_group_id, \*\*<a href="src/finch/types/payroll/pay_group_retrieve_params.py">params</a>) -> <a href="./src/finch/types/payroll/pay_group_retrieve_response.py">PayGroupRetrieveResponse</a></code>
424424
- <code title="get /employer/pay-groups">client.payroll.pay_groups.<a href="./src/finch/resources/payroll/pay_groups.py">list</a>(\*\*<a href="src/finch/types/payroll/pay_group_list_params.py">params</a>) -> <a href="./src/finch/types/payroll/pay_group_list_response.py">SyncSinglePage[PayGroupListResponse]</a></code>
425425

426426
# Connect

0 commit comments

Comments
 (0)