docs: update some builder method javadocs (#305)

Modern-Treasury · Jan 9, 2025 · b13afd8 · b13afd8
1 parent 4c7cecf
commit b13afd8
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/modern-treasury-java-core/src/main/kotlin/com/moderntreasury/api/models/BulkResult.kt b/modern-treasury-java-core/src/main/kotlin/com/moderntreasury/api/models/BulkResult.kt
@@ -265,16 +265,36 @@ private constructor(
          */
         fun entity(entity: JsonField<Entity>) = apply { this.entity = entity }
 
+        /**
+         * An object with type as indicated by `entity_type`. This is the result object that is
+         * generated by performing the requested action on the provided input `request_params`.
+         */
         fun entity(paymentOrder: PaymentOrder) = entity(Entity.ofPaymentOrder(paymentOrder))
 
+        /**
+         * An object with type as indicated by `entity_type`. This is the result object that is
+         * generated by performing the requested action on the provided input `request_params`.
+         */
         fun entity(expectedPayment: ExpectedPayment) =
             entity(Entity.ofExpectedPayment(expectedPayment))
 
+        /**
+         * An object with type as indicated by `entity_type`. This is the result object that is
+         * generated by performing the requested action on the provided input `request_params`.
+         */
         fun entity(ledgerTransaction: LedgerTransaction) =
             entity(Entity.ofLedgerTransaction(ledgerTransaction))
 
+        /**
+         * An object with type as indicated by `entity_type`. This is the result object that is
+         * generated by performing the requested action on the provided input `request_params`.
+         */
         fun entity(transaction: Transaction) = entity(Entity.ofTransaction(transaction))
 
+        /**
+         * An object with type as indicated by `entity_type`. This is the result object that is
+         * generated by performing the requested action on the provided input `request_params`.
+         */
         fun entity(bulkError: Entity.BulkError) = entity(Entity.ofBulkError(bulkError))
 
         /** Unique identifier for the result entity object. */

diff --git a/modern-treasury-java-core/src/main/kotlin/com/moderntreasury/api/models/PaymentOrder.kt b/modern-treasury-java-core/src/main/kotlin/com/moderntreasury/api/models/PaymentOrder.kt
@@ -1621,9 +1621,17 @@ private constructor(
             ultimateOriginatingAccount: JsonField<UltimateOriginatingAccount>
         ) = apply { this.ultimateOriginatingAccount = ultimateOriginatingAccount }
 
+        /**
+         * The account to which the originating of this payment should be attributed to. Can be a
+         * `virtual_account` or `internal_account`.
+         */
         fun ultimateOriginatingAccount(virtualAccount: VirtualAccount) =
             ultimateOriginatingAccount(UltimateOriginatingAccount.ofVirtualAccount(virtualAccount))
 
+        /**
+         * The account to which the originating of this payment should be attributed to. Can be a
+         * `virtual_account` or `internal_account`.
+         */
         fun ultimateOriginatingAccount(internalAccount: InternalAccount) =
             ultimateOriginatingAccount(
                 UltimateOriginatingAccount.ofInternalAccount(internalAccount)