Skip to content

Commit becaa47

Browse files
docs: add source file links to readme (#453)
1 parent 8f256fb commit becaa47

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ The asynchronous client supports the same options as the synchronous one, except
174174

175175
The SDK throws custom unchecked exception types:
176176

177-
- `FinchServiceException`: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:
177+
- [`FinchServiceException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:
178178

179179
| Status | Exception |
180180
| ------ | ------------------------------- |
@@ -187,11 +187,11 @@ The SDK throws custom unchecked exception types:
187187
| 5xx | `InternalServerException` |
188188
| others | `UnexpectedStatusCodeException` |
189189

190-
- `FinchIoException`: I/O networking errors.
190+
- [`FinchIoException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.
191191

192-
- `FinchInvalidDataException`: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.
192+
- [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.
193193

194-
- `FinchException`: Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.
194+
- [`FinchException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.
195195

196196
## Pagination
197197

@@ -371,7 +371,7 @@ HrisDirectoryListParams params = HrisDirectoryListParams.builder()
371371

372372
These can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods. You can also set undocumented parameters on nested headers, query params, or body classes using the `putAdditionalProperty` method. These properties can be accessed on the built object later using the `_additionalProperties()` method.
373373

374-
To set a documented parameter or property to an undocumented or not yet supported _value_, pass a `JsonValue` object to its setter:
374+
To set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/JsonValue.kt) object to its setter:
375375

376376
```java
377377
import com.tryfinch.api.models.HrisDirectoryListParams;
@@ -437,7 +437,7 @@ if (code.isMissing()) {
437437

438438
In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.
439439

440-
By default, the SDK will not throw an exception in this case. It will throw `FinchInvalidDataException` only if you directly access the property.
440+
By default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.
441441

442442
If you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:
443443

0 commit comments

Comments
 (0)