Skip to content

Commit 0eca3cb

Browse files
stainless-botrattrayalex
authored andcommitted
chore(api): remove deprecated & unused ATS API (#103)
1 parent 66aa272 commit 0eca3cb

29 files changed

+23
-1700
lines changed

.stats.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
configured_endpoints: 27
1+
configured_endpoints: 18

README.md

+21-20
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ client = Finch(
2727
access_token="my access token",
2828
)
2929

30-
candidate = client.ats.candidates.retrieve(
31-
"<candidate id>",
30+
page = client.hris.directory.list_individuals(
31+
candidate_id="<candidate id>",
3232
)
33-
print(candidate.first_name)
33+
directory = page.individuals[0]
34+
print(directory.first_name)
3435
```
3536

3637
## Async Usage
@@ -46,10 +47,10 @@ client = AsyncFinch(
4647

4748

4849
async def main():
49-
candidate = await client.ats.candidates.retrieve(
50-
"<candidate id>",
50+
page = await client.hris.directory.list_individuals(
51+
candidate_id="<candidate id>",
5152
)
52-
print(candidate.first_name)
53+
print(page.individuals[0].first_name)
5354

5455

5556
asyncio.run(main())
@@ -74,12 +75,12 @@ import finch
7475

7576
client = Finch()
7677

77-
all_jobs = []
78+
all_directories = []
7879
# Automatically fetches more pages as needed.
79-
for job in client.ats.jobs.list():
80-
# Do something with job here
81-
all_jobs.append(job)
82-
print(all_jobs)
80+
for directory in client.hris.directory.list_individuals():
81+
# Do something with directory here
82+
all_directories.append(directory)
83+
print(all_directories)
8384
```
8485

8586
Or, asynchronously:
@@ -92,11 +93,11 @@ client = AsyncFinch()
9293

9394

9495
async def main() -> None:
95-
all_jobs = []
96+
all_directories = []
9697
# Iterate through items across all pages, issuing requests as needed.
97-
async for job in client.ats.jobs.list():
98-
all_jobs.append(job)
99-
print(all_jobs)
98+
async for directory in client.hris.directory.list_individuals():
99+
all_directories.append(directory)
100+
print(all_directories)
100101

101102

102103
asyncio.run(main())
@@ -105,25 +106,25 @@ asyncio.run(main())
105106
Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
106107

107108
```python
108-
first_page = await client.ats.jobs.list()
109+
first_page = await client.hris.directory.list_individuals()
109110
if first_page.has_next_page():
110111
print(f"will fetch next page using these details: {first_page.next_page_info()}")
111112
next_page = await first_page.get_next_page()
112-
print(f"number of items we just fetched: {len(next_page.jobs)}")
113+
print(f"number of items we just fetched: {len(next_page.individuals)}")
113114

114115
# Remove `await` for non-async usage.
115116
```
116117

117118
Or just work directly with the returned data:
118119

119120
```python
120-
first_page = await client.ats.jobs.list()
121+
first_page = await client.hris.directory.list_individuals()
121122

122123
print(
123124
f"the current start offset for this page: {first_page.paging.offset}"
124125
) # => "the current start offset for this page: 1"
125-
for job in first_page.jobs:
126-
print(job.id)
126+
for directory in first_page.individuals:
127+
print(directory.id)
127128

128129
# Remove `await` for non-async usage.
129130
```

api.md

-66
Original file line numberDiff line numberDiff line change
@@ -133,72 +133,6 @@ Methods:
133133
- <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>
134134
- <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.py">SyncSinglePage[UnenrolledIndividual]</a></code>
135135

136-
# ATS
137-
138-
## Candidates
139-
140-
Types:
141-
142-
```python
143-
from finch.types.ats import Candidate
144-
```
145-
146-
Methods:
147-
148-
- <code title="get /ats/candidates/{candidate_id}">client.ats.candidates.<a href="./src/finch/resources/ats/candidates.py">retrieve</a>(candidate_id) -> <a href="./src/finch/types/ats/candidate.py">Candidate</a></code>
149-
- <code title="get /ats/candidates">client.ats.candidates.<a href="./src/finch/resources/ats/candidates.py">list</a>(\*\*<a href="src/finch/types/ats/candidate_list_params.py">params</a>) -> <a href="./src/finch/types/ats/candidate.py">SyncCandidatesPage[Candidate]</a></code>
150-
151-
## Applications
152-
153-
Types:
154-
155-
```python
156-
from finch.types.ats import Application
157-
```
158-
159-
Methods:
160-
161-
- <code title="get /ats/applications/{application_id}">client.ats.applications.<a href="./src/finch/resources/ats/applications.py">retrieve</a>(application_id) -> <a href="./src/finch/types/ats/application.py">Application</a></code>
162-
- <code title="get /ats/applications">client.ats.applications.<a href="./src/finch/resources/ats/applications.py">list</a>(\*\*<a href="src/finch/types/ats/application_list_params.py">params</a>) -> <a href="./src/finch/types/ats/application.py">SyncApplicationsPage[Application]</a></code>
163-
164-
## Stages
165-
166-
Types:
167-
168-
```python
169-
from finch.types.ats import Stage
170-
```
171-
172-
Methods:
173-
174-
- <code title="get /ats/stages">client.ats.stages.<a href="./src/finch/resources/ats/stages.py">list</a>() -> <a href="./src/finch/types/ats/stage.py">SyncSinglePage[Stage]</a></code>
175-
176-
## Jobs
177-
178-
Types:
179-
180-
```python
181-
from finch.types.ats import Job
182-
```
183-
184-
Methods:
185-
186-
- <code title="get /ats/jobs/{job_id}">client.ats.jobs.<a href="./src/finch/resources/ats/jobs.py">retrieve</a>(job_id) -> <a href="./src/finch/types/ats/job.py">Job</a></code>
187-
- <code title="get /ats/jobs">client.ats.jobs.<a href="./src/finch/resources/ats/jobs.py">list</a>(\*\*<a href="src/finch/types/ats/job_list_params.py">params</a>) -> <a href="./src/finch/types/ats/job.py">SyncJobsPage[Job]</a></code>
188-
189-
## Offers
190-
191-
Types:
192-
193-
```python
194-
from finch.types.ats import Offer
195-
```
196-
197-
Methods:
198-
199-
- <code title="get /ats/offers/{offer_id}">client.ats.offers.<a href="./src/finch/resources/ats/offers.py">retrieve</a>(offer_id) -> <a href="./src/finch/types/ats/offer.py">Offer</a></code>
200-
- <code title="get /ats/offers">client.ats.offers.<a href="./src/finch/resources/ats/offers.py">list</a>(\*\*<a href="src/finch/types/ats/offer_list_params.py">params</a>) -> <a href="./src/finch/types/ats/offer.py">SyncOffersPage[Offer]</a></code>
201-
202136
# Providers
203137

204138
Types:

src/finch/_client.py

-4
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@
4646

4747
class Finch(SyncAPIClient):
4848
hris: resources.HRIS
49-
ats: resources.ATS
5049
providers: resources.Providers
5150
account: resources.Account
5251
webhooks: resources.Webhooks
@@ -120,7 +119,6 @@ def __init__(
120119
)
121120

122121
self.hris = resources.HRIS(self)
123-
self.ats = resources.ATS(self)
124122
self.providers = resources.Providers(self)
125123
self.account = resources.Account(self)
126124
self.webhooks = resources.Webhooks(self)
@@ -279,7 +277,6 @@ def get_auth_url(
279277

280278
class AsyncFinch(AsyncAPIClient):
281279
hris: resources.AsyncHRIS
282-
ats: resources.AsyncATS
283280
providers: resources.AsyncProviders
284281
account: resources.AsyncAccount
285282
webhooks: resources.AsyncWebhooks
@@ -353,7 +350,6 @@ def __init__(
353350
)
354351

355352
self.hris = resources.AsyncHRIS(self)
356-
self.ats = resources.AsyncATS(self)
357353
self.providers = resources.AsyncProviders(self)
358354
self.account = resources.AsyncAccount(self)
359355
self.webhooks = resources.AsyncWebhooks(self)

0 commit comments

Comments
 (0)