FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1)

fineract-provider/src/main/java/org/apache/fineract/infrastructure/dataqueries/api/DatatablesApiResourceSwagger.java

@@ -266,6 +266,12 @@ private PutDataTablesAppTableIdDatatableIdResponse() {
         public Long loanId;
         @Schema(example = "1")
         public Long resourceId;
+        /**
+         * Carried by the {@code CommandProcessingResult} whenever the datatable hangs off a transaction - a savings
+         * transaction datatable, for instance - but it was missing here, so generated clients could not read it.
+         */
+        @Schema(example = "1")
+        public String transactionId;
         public Map<String, Object> changes;
     }
 
@@ -278,6 +284,11 @@ private DeleteDataTablesDatatableAppTableIdResponse() {
 
         @Schema(example = "1")
         public Long resourceId;
+        /**
+         * See {@link PutDataTablesAppTableIdDatatableIdResponse#transactionId}.
+         */
+        @Schema(example = "1")
+        public String transactionId;
     }
 
     @Schema(description = "DeleteDataTablesDatatableAppTableIdDatatableIdResponse ")

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/SavingsAccountTransactionsApiResource.java

@@ -21,7 +21,6 @@
 import com.google.gson.JsonObject;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
@@ -331,7 +330,7 @@ private String transaction(final Long savingsId, final String savingsExternalIdS
             + "Accepted command = undo, reverse, modify, releaseAmount")
     @AlternativeOperationId("adjustTransaction_1")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SavingsAccountTransactionsApiResourceSwagger.PostSavingsAccountBulkReversalTransactionsRequest.class)))
-    @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = SavingsAccountTransactionsApiResourceSwagger.PostSavingsAccountBulkReversalTransactionsRequest.class))))
+    @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = CommandProcessingResult.class)))
     public String adjustTransaction(@PathParam("savingsId") final Long savingsId, @PathParam("transactionId") final Long transactionId,
             @QueryParam("command") final String commandParam, final String apiRequestBodyAsJson) {
         return adjustTransaction(savingsId, null, transactionId, null, commandParam, apiRequestBodyAsJson);
@@ -346,7 +345,7 @@ public String adjustTransaction(@PathParam("savingsId") final Long savingsId, @P
             + "savingsaccounts/external-id/{savingsExternalId}/transactions/{transactionId}?command=reverse\n" + "\n"
             + "Accepted command = undo, reverse, modify, releaseAmount")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SavingsAccountTransactionsApiResourceSwagger.PostSavingsAccountBulkReversalTransactionsRequest.class)))
-    @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = SavingsAccountTransactionsApiResourceSwagger.PostSavingsAccountBulkReversalTransactionsRequest.class))))
+    @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = CommandProcessingResult.class)))
     public String adjustTransaction(@PathParam("savingsExternalId") final String savingsExternalId,
             @PathParam("transactionId") final Long transactionId, @QueryParam("command") final String commandParam,
             final String apiRequestBodyAsJson) {
@@ -391,7 +390,7 @@ private String adjustTransaction(final Long savingsId, final String savingsExter
             + "savingsaccounts/{savingsId}/transactions/external-id/{transactionExternalId}?command=reverse\n" + "\n"
             + "Accepted command = undo, reverse, modify, releaseAmount")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SavingsAccountTransactionsApiResourceSwagger.PostSavingsAccountBulkReversalTransactionsRequest.class)))
-    @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = SavingsAccountTransactionsApiResourceSwagger.PostSavingsAccountBulkReversalTransactionsRequest.class))))
+    @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = CommandProcessingResult.class)))
     public String adjustTransaction(@PathParam("savingsId") final Long savingsId,
             @PathParam("transactionExternalId") final String transactionExternalId, @QueryParam("command") final String commandParam,
             final String apiRequestBodyAsJson) {
@@ -407,7 +406,7 @@ public String adjustTransaction(@PathParam("savingsId") final Long savingsId,
             + "savingsaccounts/external-id/{savingsExternalId}/transactions/external-id/{transactionExternalId}?command=reverse\n" + "\n"
             + "Accepted command = undo, reverse, modify, releaseAmount")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SavingsAccountTransactionsApiResourceSwagger.PostSavingsAccountBulkReversalTransactionsRequest.class)))
-    @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = SavingsAccountTransactionsApiResourceSwagger.PostSavingsAccountBulkReversalTransactionsRequest.class))))
+    @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = CommandProcessingResult.class)))
     public String adjustTransaction(@PathParam("savingsExternalId") final String savingsExternalId,
             @PathParam("transactionExternalId") final String transactionExternalId, @QueryParam("command") final String commandParam,
             final String apiRequestBodyAsJson) {

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/SavingsAccountTransactionsApiResourceSwagger.java

@@ -22,6 +22,7 @@
 import java.math.BigDecimal;
 import java.time.LocalDate;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 import org.apache.fineract.portfolio.TransactionEntryType;
 
@@ -188,7 +189,12 @@ private GetSavingsAccountChargesPaidByData() {}
 
         @Schema(example = "2")
         public Long total;
-        public Set<GetSavingsAccountTransactionsPageItem> content;
+        /**
+         * A page of search results is ordered by the request's {@code orderBy}/{@code sortOrder} (defaulting to most
+         * recent first), so it is documented as an ordered list. Declaring it as a set made generated clients drop that
+         * ordering. The serialized response is a JSON array either way, so the wire format is unchanged.
+         */
+        public List<GetSavingsAccountTransactionsPageItem> content;
     }
 
     @Schema(description = "PostSavingsAccountTransactionsRequest")
@@ -209,11 +215,15 @@ private PostSavingsAccountTransactionsRequest() {}
         @Schema(example = "true")
         public Boolean isPostInterestAsOn;
         @Schema(example = "true")
+        public Boolean postInterestManualOrAutomatic;
+        @Schema(example = "true")
         public String lienAllowed;
         @Schema(example = "String")
         public String reasonForBlock;
         @Schema(example = "1")
         public Integer paymentTypeId;
+        @Schema(example = "A note about this transaction")
+        public String note;
     }
 
     @Schema(description = "PostSavingsAccountTransactionsResponse")

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/SavingsAccountsApiResourceSwagger.java

@@ -309,6 +309,8 @@ private PutSavingsAccountsAccountIdRequest() {}
         public Long productId;
         @Schema(example = "01 March 2011")
         public String submittedOnDate;
+        @Schema(example = "true")
+        public Boolean withdrawalFeeForTransfers;
     }
 
     @Schema(description = "PutSavingsAccountsAccountIdResponse")

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/SavingsProductsApiResourceSwagger.java

@@ -84,6 +84,41 @@ private PostSavingsCharges() {}
         public Boolean withHoldTax;
         @Schema(example = "false")
         public Boolean isDormancyTrackingActive;
+        /*
+         * The overdraft settings and the GL account mappings below have always been accepted by the endpoint - they are
+         * part of SAVINGS_PRODUCT_REQUEST_DATA_PARAMETERS - but were never documented, so a typed client could not
+         * create an accrual-based or overdraft-enabled product at all.
+         */
+        @Schema(example = "10000")
+        public BigDecimal overdraftLimit;
+        @Schema(example = "21.0")
+        public BigDecimal nominalAnnualInterestRateOverdraft;
+        @Schema(example = "1")
+        public Long savingsReferenceAccountId;
+        @Schema(example = "1")
+        public Long savingsControlAccountId;
+        @Schema(example = "1")
+        public Long transfersInSuspenseAccountId;
+        @Schema(example = "1")
+        public Long interestOnSavingsAccountId;
+        @Schema(example = "1")
+        public Long writeOffAccountId;
+        @Schema(example = "1")
+        public Long incomeFromFeeAccountId;
+        @Schema(example = "1")
+        public Long incomeFromPenaltyAccountId;
+        @Schema(example = "1")
+        public Long incomeFromInterestId;
+        @Schema(example = "1")
+        public Long overdraftPortfolioControlId;
+        @Schema(example = "1")
+        public Long feesReceivableAccountId;
+        @Schema(example = "1")
+        public Long penaltiesReceivableAccountId;
+        @Schema(example = "1")
+        public Long interestPayableAccountId;
+        @Schema(example = "1")
+        public Long interestReceivableAccountId;
     }
 
     @Schema(description = "PostSavingsProductsResponse")
@@ -95,6 +130,11 @@ private PostSavingsProductsResponse() {}
         public Long resourceId;
     }
 
+    /**
+     * An update is validated against the same {@code SAVINGS_PRODUCT_REQUEST_DATA_PARAMETERS} set as a create, so it
+     * accepts the whole product body rather than the three fields that used to be documented here. The extra fields are
+     * listed so a typed client can repoint an accounting mapping or an overdraft setting without hand-building JSON.
+     */
     @Schema(description = "PutSavingsProductsProductIdRequest")
     public static final class PutSavingsProductsProductIdRequest {
 
@@ -106,6 +146,68 @@ private PutSavingsProductsProductIdRequest() {}
         public String locale;
         @Schema(example = "5.73")
         public Double interestRate;
+        @Schema(example = "Passbook Savings")
+        public String name;
+        @Schema(example = "PBSV")
+        public String shortName;
+        @Schema(example = "USD")
+        public String currencyCode;
+        @Schema(example = "2")
+        public Integer digitsAfterDecimal;
+        @Schema(example = "0")
+        public Integer inMultiplesOf;
+        @Schema(example = "5.0")
+        public Double nominalAnnualInterestRate;
+        @Schema(example = "10000.0")
+        public BigDecimal minRequiredOpeningBalance;
+        @Schema(example = "1")
+        public Integer interestCompoundingPeriodType;
+        @Schema(example = "4")
+        public Integer interestPostingPeriodType;
+        @Schema(example = "1")
+        public Integer interestCalculationType;
+        @Schema(example = "365")
+        public Integer interestCalculationDaysInYearType;
+        @Schema(example = "1")
+        public Integer accountingRule;
+        @Schema(example = "false")
+        public Boolean withdrawalFeeForTransfers;
+        @Schema(example = "false")
+        public Boolean enforceMinRequiredBalance;
+        @Schema(example = "false")
+        public Boolean allowOverdraft;
+        @Schema(example = "false")
+        public Boolean withHoldTax;
+        @Schema(example = "10000")
+        public BigDecimal overdraftLimit;
+        @Schema(example = "21.0")
+        public BigDecimal nominalAnnualInterestRateOverdraft;
+        @Schema(example = "1")
+        public Long savingsReferenceAccountId;
+        @Schema(example = "1")
+        public Long savingsControlAccountId;
+        @Schema(example = "1")
+        public Long transfersInSuspenseAccountId;
+        @Schema(example = "1")
+        public Long interestOnSavingsAccountId;
+        @Schema(example = "1")
+        public Long writeOffAccountId;
+        @Schema(example = "1")
+        public Long incomeFromFeeAccountId;
+        @Schema(example = "1")
+        public Long incomeFromPenaltyAccountId;
+        @Schema(example = "1")
+        public Long incomeFromInterestId;
+        @Schema(example = "1")
+        public Long overdraftPortfolioControlId;
+        @Schema(example = "1")
+        public Long feesReceivableAccountId;
+        @Schema(example = "1")
+        public Long penaltiesReceivableAccountId;
+        @Schema(example = "1")
+        public Long interestPayableAccountId;
+        @Schema(example = "1")
+        public Long interestReceivableAccountId;
     }
 
     @Schema(description = "PutSavingsProductsProductIdResponse")