Rename payload and add function comment

Author: hafizrahman

plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/network/rest/wpcom/wc/order/OrderRestClient.kt

@@ -30,7 +30,7 @@ import org.wordpress.android.fluxc.network.rest.wpcom.wc.toWooError
 import org.wordpress.android.fluxc.persistence.entity.OrderNoteEntity
 import org.wordpress.android.fluxc.store.WCOrderStore
 import org.wordpress.android.fluxc.store.WCOrderStore.AddOrderShipmentTrackingResponsePayload
-import org.wordpress.android.fluxc.store.WCOrderStore.BulkUpdateOrderStatusPayload
+import org.wordpress.android.fluxc.store.WCOrderStore.BulkUpdateOrderStatusResponsePayload
 import org.wordpress.android.fluxc.store.WCOrderStore.DeleteOrderShipmentTrackingResponsePayload
 import org.wordpress.android.fluxc.store.WCOrderStore.FetchHasOrdersResponsePayload
 import org.wordpress.android.fluxc.store.WCOrderStore.FetchOrderListResponsePayload
@@ -1074,14 +1074,25 @@ class OrderRestClient @Inject constructor(
         }
     }
 
+    /**
+    * Performs a batch update of order statuses via the WooCommerce REST API.
+    *
+    * This endpoint enables updating multiple orders to the same status in a single network request.
+    * The WooCommerce API has a limit of 100 orders per batch update.
+    *
+    * @param site The site to perform the update on
+    * @param orderIds List of order IDs to update. Error if exceeds [BATCH_UPDATE_LIMIT]
+    * @param newStatus The new status to set for all specified orders
+    * @return [BulkUpdateOrderStatusResponsePayload] containing either the update results or an error
+    */
     suspend fun batchUpdateOrdersStatus(
         site: SiteModel,
         orderIds: List<Long>,
         newStatus: String
-    ): BulkUpdateOrderStatusPayload {
+    ): BulkUpdateOrderStatusResponsePayload {
         // Check batch update limit
         if (orderIds.size > BATCH_UPDATE_LIMIT) {
-            return BulkUpdateOrderStatusPayload(
+            return BulkUpdateOrderStatusResponsePayload(
                 error = OrderError(
                     type = OrderErrorType.BULK_UPDATE_LIMIT_EXCEEDED,
                     message = "Cannot update more than 100 orders at once"
@@ -1107,15 +1118,15 @@ class OrderRestClient @Inject constructor(
         return when (response) {
             is WPAPIResponse.Success -> {
                 response.data?.let {
-                    BulkUpdateOrderStatusPayload(it.update)
-                } ?: BulkUpdateOrderStatusPayload(
+                    BulkUpdateOrderStatusResponsePayload(it.update)
+                } ?: BulkUpdateOrderStatusResponsePayload(
                     OrderError(GENERIC_ERROR, "Success response with empty data")
                 )
             }
 
             is WPAPIResponse.Error -> {
                 val orderError = wpAPINetworkErrorToOrderError(response.error)
-                BulkUpdateOrderStatusPayload(orderError)
+                BulkUpdateOrderStatusResponsePayload(orderError)
             }
         }
     }

plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/store/WCOrderStore.kt

@@ -298,7 +298,7 @@ class WCOrderStore @Inject constructor(
         }
     }
 
-    class BulkUpdateOrderStatusPayload(
+    class BulkUpdateOrderStatusResponsePayload(
         val response: List<BatchOrderApiResponse.OrderResponse>
     ) : Payload<OrderError>() {
         constructor(error: OrderError) : this(emptyList()) {