fix bug with cancel and delete shipment

cybernerdie · Jul 18, 2023 · 37d5de3 · 37d5de3 · vercel · Jul 18, 2023
1 parent 22ca7e4
commit 37d5de3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 12 deletions.
diff --git a/docs/shipment/index.md b/docs/shipment/index.md
@@ -69,23 +69,17 @@ $shipment = TerminalAfrica::trackShipment($shipmentId);
 This method allows you to cancel a shipment before carrier pickup.
 
 ```php
-$shipmentPayload = [
-  'shipment_id' => 'xxxxxxxxx'
-];
-
-$shipment = TerminalAfrica::cancelShipment($shipmentPayload);
+$shipmentId = 'xxxxxxxxx';
+$shipment = TerminalAfrica::cancelShipment($shipmentId);
 ```
 
 ## Delete Shipment
 
 This method allows you to delete a draft shipment.
 
 ```php
-$shipmentPayload = [
-  'shipment_id' => 'xxxxxxxxx'
-];
-
-$shipment = TerminalAfrica::deleteShipment($shipmentPayload);
+$shipmentId = 'xxxxxxxxx';
+$shipment = TerminalAfrica::deleteShipment($shipmentId);
 ```
 
 ## Arrange Pickup and Delivery for Shipment

diff --git a/src/Traits/ShipmentApi.php b/src/Traits/ShipmentApi.php
@@ -91,10 +91,14 @@ public function trackShipment(string $shipmentId): array
     /**
      * This method allows you to cancel a shipment.
      */
-    public function cancelShipment(array $formParams): array
+    public function cancelShipment(string $shipmentId): array
     {
         $endpoint = sprintf('%s/cancel', TerminalAfricaConstant::SHIPMENT_ENDPOINT);
 
+        $formParams = [
+            'shipment_id' => $shipmentId
+        ];
+
         return $this->makeRequest(
             method: 'POST',
             endpoint: $endpoint,
@@ -105,10 +109,14 @@ public function cancelShipment(array $formParams): array
     /**
      * This method allows you to delete a shipment.
      */
-    public function deleteShipment(array $formParams): array
+    public function deleteShipment(string $shipmentId): array
     {
         $endpoint = sprintf('%s', TerminalAfricaConstant::SHIPMENT_ENDPOINT);
 
+        $formParams = [
+            'shipment_id' => $shipmentId
+        ];
+
         return $this->makeRequest(
             method: 'DELETE',
             endpoint: $endpoint,