Skip to content

Commit e2f42d1

Browse files
docs: add comment for arbitrary value fields
1 parent 10357a9 commit e2f42d1

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

orb-java-core/src/main/kotlin/com/withorb/api/models/ChangedSubscriptionResources.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -790,6 +790,11 @@ private constructor(
790790
* This field is deprecated in favor of `discounts`. If a `discounts` list is provided, the
791791
* first discount in the list will be returned. If the list is empty, `None` will be
792792
* returned.
793+
*
794+
* This arbitrary value can be deserialized into a custom type using the `convert` method:
795+
* ```java
796+
* MyClass myObject = createdInvoice.discount().convert(MyClass.class);
797+
* ```
793798
*/
794799
@Deprecated("deprecated")
795800
@JsonProperty("discount")

orb-java-core/src/main/kotlin/com/withorb/api/models/Invoice.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,11 @@ private constructor(
450450
/**
451451
* This field is deprecated in favor of `discounts`. If a `discounts` list is provided, the
452452
* first discount in the list will be returned. If the list is empty, `None` will be returned.
453+
*
454+
* This arbitrary value can be deserialized into a custom type using the `convert` method:
455+
* ```java
456+
* MyClass myObject = invoice.discount().convert(MyClass.class);
457+
* ```
453458
*/
454459
@Deprecated("deprecated")
455460
@JsonProperty("discount")

orb-java-core/src/main/kotlin/com/withorb/api/models/InvoiceFetchUpcomingResponse.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,11 @@ private constructor(
443443
/**
444444
* This field is deprecated in favor of `discounts`. If a `discounts` list is provided, the
445445
* first discount in the list will be returned. If the list is empty, `None` will be returned.
446+
*
447+
* This arbitrary value can be deserialized into a custom type using the `convert` method:
448+
* ```java
449+
* MyClass myObject = invoiceFetchUpcomingResponse.discount().convert(MyClass.class);
450+
* ```
446451
*/
447452
@Deprecated("deprecated")
448453
@JsonProperty("discount")

0 commit comments

Comments
 (0)