Skip to content

Commit a1f83d6

Browse files
docs: add comment for arbitrary value fields
1 parent 20e5c53 commit a1f83d6

File tree

4 files changed

+31
-0
lines changed

4 files changed

+31
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -921,6 +921,12 @@ private constructor(
921921
*/
922922
fun name(): Optional<String> = name.getOptional("name")
923923

924+
/**
925+
* This arbitrary value can be deserialized into a custom type using the `convert` method:
926+
* ```java
927+
* MyClass myObject = customField.value().convert(MyClass.class);
928+
* ```
929+
*/
924930
@JsonProperty("value") @ExcludeMissing fun _value(): JsonValue = value
925931

926932
/**

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ private constructor(
3434
/** The entity IDs to update the rule for. */
3535
fun entityIds(): Optional<List<String>> = Optional.ofNullable(entityIds)
3636

37+
/**
38+
* This arbitrary value can be deserialized into a custom type using the `convert` method:
39+
* ```java
40+
* MyClass myObject = hrisCompanyPayStatementItemRuleUpdateParams.optionalProperty().convert(MyClass.class);
41+
* ```
42+
*/
3743
fun _optionalProperty(): JsonValue = body._optionalProperty()
3844

3945
fun _additionalBodyProperties(): Map<String, JsonValue> = body._additionalProperties()
@@ -278,6 +284,12 @@ private constructor(
278284
optionalProperty: JsonValue = JsonMissing.of()
279285
) : this(optionalProperty, mutableMapOf())
280286

287+
/**
288+
* This arbitrary value can be deserialized into a custom type using the `convert` method:
289+
* ```java
290+
* MyClass myObject = updateRuleRequest.optionalProperty().convert(MyClass.class);
291+
* ```
292+
*/
281293
@JsonProperty("optionalProperty")
282294
@ExcludeMissing
283295
fun _optionalProperty(): JsonValue = optionalProperty

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1511,6 +1511,13 @@ private constructor(
15111511
*/
15121512
fun name(): Optional<String> = name.getOptional("name")
15131513

1514+
/**
1515+
* This arbitrary value can be deserialized into a custom type using the `convert`
1516+
* method:
1517+
* ```java
1518+
* MyClass myObject = customField.value().convert(MyClass.class);
1519+
* ```
1520+
*/
15141521
@JsonProperty("value") @ExcludeMissing fun _value(): JsonValue = value
15151522

15161523
/**

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1767,6 +1767,12 @@ private constructor(
17671767
*/
17681768
fun name(): Optional<String> = name.getOptional("name")
17691769

1770+
/**
1771+
* This arbitrary value can be deserialized into a custom type using the `convert` method:
1772+
* ```java
1773+
* MyClass myObject = customField.value().convert(MyClass.class);
1774+
* ```
1775+
*/
17701776
@JsonProperty("value") @ExcludeMissing fun _value(): JsonValue = value
17711777

17721778
/**

0 commit comments

Comments
 (0)