chore(api): remove deprecated & unused ATS API (#68)

Author: stainless-bot

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 27
+configured_endpoints: 18

README.md

@@ -79,31 +79,32 @@ Read the documentation for more configuration options.
 
 ### Example: creating a resource
 
-To create a new ats candidate, first use the `AtsCandidateRetrieveParams` builder to specify attributes,
-then pass that to the `retrieve` method of the `candidates` service.
+To create a new hris directory, first use the `HrisDirectoryListIndividualsParams` builder to specify attributes,
+then pass that to the `listIndividuals` method of the `directory` service.
 
 ```java
-import com.tryfinch.api.models.AtsCandidateRetrieveParams;
-import com.tryfinch.api.models.Candidate;
+import com.tryfinch.api.models.HrisDirectoryListIndividualsPage;
+import com.tryfinch.api.models.HrisDirectoryListIndividualsParams;
+import com.tryfinch.api.models.Page;
 
-AtsCandidateRetrieveParams params = AtsCandidateRetrieveParams.builder()
+HrisDirectoryListIndividualsParams params = HrisDirectoryListIndividualsParams.builder()
     .candidateId("<candidate id>")
     .build();
-Candidate atsCandidate = client.candidates().retrieve(params);
+HrisDirectoryListIndividualsPage hrisDirectory = client.directory().listIndividuals(params);
 ```
 
 ### Example: listing resources
 
-The Finch API provides a `list` method to get a paginated list of jobs.
+The Finch API provides a `listIndividuals` method to get a paginated list of directory.
 You can retrieve the first page by:
 
 ```java
-import com.tryfinch.api.models.Job;
+import com.tryfinch.api.models.IndividualInDirectory;
 import com.tryfinch.api.models.Page;
 
-AtsJobListPage page = client.jobs().list();
-for (Job job : page.jobs()) {
-    System.out.println(job);
+HrisDirectoryListIndividualsPage page = client.directory().listIndividuals();
+for (IndividualInDirectory directory : page.individuals()) {
+    System.out.println(directory);
 }
 ```
 
@@ -117,14 +118,14 @@ See [Pagination](#pagination) below for more information on transparently workin
 
 To make a request to the Finch API, you generally build an instance of the appropriate `Params` class.
 
-In [Example: creating a resource](#example-creating-a-resource) above, we used the `AtsCandidateRetrieveParams.builder()` to pass to
-the `retrieve` method of the `candidates` service.
+In [Example: creating a resource](#example-creating-a-resource) above, we used the `HrisDirectoryListIndividualsParams.builder()` to pass to
+the `listIndividuals` method of the `directory` service.
 
 Sometimes, the API may support other properties that are not yet supported in the Java SDK types. In that case,
 you can attach them using the `putAdditionalProperty` method.
 
 ```java
-AtsCandidateRetrieveParams params = AtsCandidateRetrieveParams.builder()
+HrisDirectoryListIndividualsParams params = HrisDirectoryListIndividualsParams.builder()
     // ... normal properties
     .putAdditionalProperty("secret_param", "4242")
     .build();
@@ -137,7 +138,7 @@ AtsCandidateRetrieveParams params = AtsCandidateRetrieveParams.builder()
 When receiving a response, the Finch Java SDK will deserialize it into instances of the typed model classes. In rare cases, the API may return a response property that doesn't match the expected Java type. If you directly access the mistaken property, the SDK will throw an unchecked `FinchInvalidDataException` at runtime. If you would prefer to check in advance that that response is completely well-typed, call `.validate()` on the returned model.
 
 ```java
-Candidate atsCandidate = client.candidates().retrieve().validate();
+HrisDirectoryListIndividualsPage hrisDirectory = client.directory().listIndividuals().validate();
 ```
 
 ### Response properties as JSON
@@ -167,7 +168,7 @@ if (field.isMissing()) {
 Sometimes, the server response may include additional properties that are not yet available in this library's types. You can access them using the model's `_additionalProperties` method:
 
 ```java
-JsonValue secret = atsCandidate._additionalProperties().get("secret_field");
+JsonValue secret = hrisDirectory._additionalProperties().get("secret_field");
 ```
 
 ---
@@ -186,23 +187,23 @@ which automatically handles fetching more pages for you:
 
 ```java
 // As an Iterable:
-AtsJobListPage page = client.jobs().list(params);
-for (Job job : page.autoPager()) {
-    System.out.println(job);
+HrisDirectoryListIndividualsPage page = client.directory().listIndividuals(params);
+for (IndividualInDirectory directory : page.autoPager()) {
+    System.out.println(directory);
 };
 
 // As a Stream:
-client.jobs().list(params).autoPager().stream()
+client.directory().listIndividuals(params).autoPager().stream()
     .limit(50)
-    .forEach(job -> System.out.println(job));
+    .forEach(directory -> System.out.println(directory));
 ```
 
 ### Asynchronous
 
 ```java
 // Using forEach, which returns CompletableFuture<Void>:
-asyncClient.jobs().list(params).autoPager()
-    .forEach(job -> System.out.println(job), executor);
+asyncClient.directory().listIndividuals(params).autoPager()
+    .forEach(directory -> System.out.println(directory), executor);
 ```
 
 ### Manual pagination
@@ -213,10 +214,10 @@ A page of results has a `data()` method to fetch the list of objects, as well as
 `hasNextPage`, `getNextPage`, and `getNextPageParams` methods to help with pagination.
 
 ```java
-AtsJobListPage page = client.jobs().list(params);
+HrisDirectoryListIndividualsPage page = client.directory().listIndividuals(params);
 while (page != null) {
-    for (Job job : page.jobs()) {
-        System.out.println(job);
+    for (IndividualInDirectory directory : page.individuals()) {
+        System.out.println(directory);
     }
 
     page = page.getNextPage().orElse(null);

buildSrc/src/main/kotlin/finch.publish.gradle.kts

@@ -15,8 +15,8 @@ configure<PublishingExtension> {
             from(components["java"])
 
             pom {
-                name.set("ATS API Reference")
-                description.set("The Finch ATS (Applicant Tracking System) API provides a unified way to connect\nto a multitude of ATS providers. The API requires an access token issued by\nFinch.\n\nTo enable access to the ATS API, please reach out to your Finch representative.\n\nATS products are specified by the product parameter, a space-separated list of\nproducts that your application requests from an employer authenticating through\nFinch Connect. Valid product names are—\n\n- `candidates`: Read candidate data\n- `applications`: Read detailed application data for candidates\n- `jobs`: Read job posting data, as well as existing stages of the job pipeline\n- `offers`: Read details about offers managed through the ATS")
+                name.set("API Reference")
+                description.set("Finch's Employer API requires an access token issued by Finch.\n\nPlease see\n[here](https://developer.tryfinch.com/docs/reference/branches/open-api/docs/%20Finch%20API/1%20-%20Getting%20Started.md)\nfor an overview of the API\n\nEmployer products are specified by the product parameter, a space-separated list\nof products that your application requests from an employer authenticating\nthrough Finch Connect. Valid product names are—\n\n- `company`: Read basic company data\n\n- `directory`: Read company directory and organization structure\n\n- `individual`: Read individual data, excluding income and employment data\n\n- `employment`: Read individual employment and income data\n\n- `payment`: Read payroll and contractor related payments by the company\n\n- `pay_statement`: Read detailed pay statements for each individual\n\n- `benefits`: Create and manage benefits and benefit enrollment within a company\n\n- `deduction` (deprecated): Previously used to manage deductions within a\n  company. Please use `benefits`.\n\n[![Open in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4?action=collection%2Ffork&collection-url=entityId%3D21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4%26entityType%3Dcollection%26workspaceId%3D1edf19bc-e0a8-41e9-ac55-481a4b50790b)")
                 url.set("https://developer.tryfinch.com/")
 
                 licenses {

finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt

@@ -12,8 +12,6 @@ interface FinchClient {
 
     fun hris(): HrisService
 
-    fun ats(): AtsService
-
     fun providers(): ProviderService
 
     fun account(): AccountService

finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt

@@ -13,8 +13,6 @@ interface FinchClientAsync {
 
     fun hris(): HrisServiceAsync
 
-    fun ats(): AtsServiceAsync
-
     fun providers(): ProviderServiceAsync
 
     fun account(): AccountServiceAsync

finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt

@@ -27,8 +27,6 @@ constructor(
 
     private val hris: HrisServiceAsync by lazy { HrisServiceAsyncImpl(clientOptions) }
 
-    private val ats: AtsServiceAsync by lazy { AtsServiceAsyncImpl(clientOptions) }
-
     private val providers: ProviderServiceAsync by lazy { ProviderServiceAsyncImpl(clientOptions) }
 
     private val account: AccountServiceAsync by lazy { AccountServiceAsyncImpl(clientOptions) }
@@ -42,8 +40,6 @@ constructor(
 
     override fun hris(): HrisServiceAsync = hris
 
-    override fun ats(): AtsServiceAsync = ats
-
     override fun providers(): ProviderServiceAsync = providers
 
     override fun account(): AccountServiceAsync = account

finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt

@@ -26,8 +26,6 @@ constructor(
 
     private val hris: HrisService by lazy { HrisServiceImpl(clientOptions) }
 
-    private val ats: AtsService by lazy { AtsServiceImpl(clientOptions) }
-
     private val providers: ProviderService by lazy { ProviderServiceImpl(clientOptions) }
 
     private val account: AccountService by lazy { AccountServiceImpl(clientOptions) }
@@ -41,8 +39,6 @@ constructor(
 
     override fun hris(): HrisService = hris
 
-    override fun ats(): AtsService = ats
-
     override fun providers(): ProviderService = providers
 
     override fun account(): AccountService = account