chore(docs): improve docstrings (#255)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 36
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch-aeb62bc4875f4eb1b2ae1f75ef9521e92022e863cba2ae67f907ed27ca93d527.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch-15385b754979d87bd7e583f618870246e79d1430a761e5bcd653db78cfab4789.yml

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

@@ -16,7 +16,7 @@ configure<PublishingExtension> {
 
             pom {
                 name.set("API Reference")
-                description.set("The Finch HRIS API provides a unified way to connect to a multitide of HRIS\nsystems. The API requires an access token issued by Finch.\n\nBy default, Organization and Payroll requests use Finch\'s\n[Data Syncs](/development-guides/Data-Syncs). If a request is made before the\ninitial sync has completed, Finch will request data live from the provider. The\nlatency on live requests may range from seconds to minutes depending on the\nprovider and batch size. For automated integrations, Deductions requests (both\nread and write) are always made live to the provider. Latencies may range from\nseconds to minutes depending on the provider and batch size.\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 deductions and contributions and enrollment for\n  an employer\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)")
+                description.set("The Finch HRIS API provides a unified way to connect to a multitide of HRIS\nsystems. The API requires an access token issued by Finch.\n\nBy default, Organization and Payroll requests use Finch\'s\n[Data Syncs](/developer-resources/Data-Syncs). If a request is made before the\ninitial sync has completed, Finch will request data live from the provider. The\nlatency on live requests may range from seconds to minutes depending on the\nprovider and batch size. For automated integrations, Deductions requests (both\nread and write) are always made live to the provider. Latencies may range from\nseconds to minutes depending on the provider and batch size.\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 deductions and contributions and enrollment for\n  an employer\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/models/Individual.kt

@@ -76,6 +76,7 @@ private constructor(
     /**
      * Social Security Number of the individual. This field is only available with the `ssn` scope
      * enabled and the `options: { include: ['ssn'] }` param set in the body.
+     * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
      */
     fun ssn(): Optional<String> = Optional.ofNullable(ssn.getNullable("ssn"))
 
@@ -119,6 +120,7 @@ private constructor(
     /**
      * Social Security Number of the individual. This field is only available with the `ssn` scope
      * enabled and the `options: { include: ['ssn'] }` param set in the body.
+     * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
      */
     @JsonProperty("ssn") @ExcludeMissing fun _ssn() = ssn
 
@@ -328,12 +330,14 @@ private constructor(
         /**
          * Social Security Number of the individual. This field is only available with the `ssn`
          * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+         * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
          */
         fun ssn(ssn: String) = ssn(JsonField.of(ssn))
 
         /**
          * Social Security Number of the individual. This field is only available with the `ssn`
          * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+         * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
          */
         @JsonProperty("ssn")
         @ExcludeMissing

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

@@ -71,6 +71,7 @@ private constructor(
     /**
      * Social Security Number of the individual. This field is only available with the `ssn` scope
      * enabled and the `options: { include: ['ssn'] }` param set in the body.
+     * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
      */
     fun ssn(): Optional<String> = Optional.ofNullable(ssn.getNullable("ssn"))
 
@@ -114,6 +115,7 @@ private constructor(
     /**
      * Social Security Number of the individual. This field is only available with the `ssn` scope
      * enabled and the `options: { include: ['ssn'] }` param set in the body.
+     * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
      */
     @JsonProperty("ssn") @ExcludeMissing fun _ssn() = ssn
 
@@ -316,12 +318,14 @@ private constructor(
         /**
          * Social Security Number of the individual. This field is only available with the `ssn`
          * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+         * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
          */
         fun ssn(ssn: String) = ssn(JsonField.of(ssn))
 
         /**
          * Social Security Number of the individual. This field is only available with the `ssn`
          * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+         * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
          */
         @JsonProperty("ssn")
         @ExcludeMissing

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

@@ -267,6 +267,7 @@ constructor(
         /**
          * Social Security Number of the individual. This field is only available with the `ssn`
          * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+         * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
          */
         @JsonProperty("ssn") fun ssn(): String? = ssn
 
@@ -499,6 +500,7 @@ constructor(
             /**
              * Social Security Number of the individual. This field is only available with the `ssn`
              * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+             * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
              */
             @JsonProperty("ssn") fun ssn(ssn: String) = apply { this.ssn = ssn }
 

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

@@ -151,6 +151,7 @@ constructor(
         /**
          * Social Security Number of the individual. This field is only available with the `ssn`
          * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+         * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
          */
         @JsonProperty("ssn") fun ssn(): String? = ssn
 
@@ -290,6 +291,7 @@ constructor(
             /**
              * Social Security Number of the individual. This field is only available with the `ssn`
              * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+             * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
              */
             @JsonProperty("ssn") fun ssn(ssn: String) = apply { this.ssn = ssn }
 
@@ -475,6 +477,7 @@ constructor(
         /**
          * Social Security Number of the individual. This field is only available with the `ssn`
          * scope enabled and the `options: { include: ['ssn'] }` param set in the body.
+         * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
          */
         fun ssn(ssn: String) = apply { this.ssn = ssn }