Implementada melhoria de captura e cancelamento parcial, closes #2

lcsLucas · lcsLucas · commit 08dff71da92c · 2023-12-22T13:13:33.000-03:00
diff --git a/README.md b/README.md
@@ -288,37 +288,37 @@ $responsePayment = $ipagClient->payment()->getByUuid($orderId);
 ### Capturar Pagamento
 
 ```php
-$responsePayment = $ipagClient->payment()->captureById($transactionId);
+$responsePayment = $ipagClient->payment()->captureById($transactionId, $amount);
 ```
 ou
 ```php
-$responsePayment = $ipagClient->payment()->captureByUuid($transactionUuid);
+$responsePayment = $ipagClient->payment()->captureByUuid($transactionUuid, $amount);
 ```
 ou
 ```php
-$responsePayment = $ipagClient->payment()->captureByUuid($transactionTid);
+$responsePayment = $ipagClient->payment()->captureByUuid($transactionTid, $amount);
 ```
 ou
 ```php
-$responsePayment = $ipagClient->payment()->captureByUuid($orderId);
+$responsePayment = $ipagClient->payment()->captureByUuid($orderId, $amount);
 ```
 
 ### Cancelar Pagamento
 
 ```php
-$responsePayment = $ipagClient->payment()->cancelById($transactionId);
+$responsePayment = $ipagClient->payment()->cancelById($transactionId, $amount);
 ```
 ou
 ```php
-$responsePayment = $ipagClient->payment()->cancelByUuid($transactionUuid);
+$responsePayment = $ipagClient->payment()->cancelByUuid($transactionUuid, $amount);
 ```
 ou
 ```php
-$responsePayment = $ipagClient->payment()->cancelByUuid($transactionTid);
+$responsePayment = $ipagClient->payment()->cancelByUuid($transactionTid, $amount);
 ```
 ou
 ```php
-$responsePayment = $ipagClient->payment()->cancelByUuid($orderId);
+$responsePayment = $ipagClient->payment()->cancelByUuid($orderId, $amount);
 ```
 
 > Todos os exemplos: [examples/payment/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/payment/)
diff --git a/examples/payment/14-payment-capture-by-id.php b/examples/payment/14-payment-capture-by-id.php
@@ -6,7 +6,7 @@
 
     $transactionId = 123;
 
-    $responsePayment = $ipagClient->payment()->captureById($transactionId);
+    $responsePayment = $ipagClient->payment()->captureById($transactionId, 50.00);
     $data = $responsePayment->getData();
 
     $statusPayment = $responsePayment->getParsedPath('attributes.status.code');
@@ -41,4 +41,5 @@
     var_dump($error);
     echo "</pre>" . PHP_EOL;
 
-}
+}
+
diff --git a/examples/payment/15-payment-capture-by-uuid.php b/examples/payment/15-payment-capture-by-uuid.php
@@ -6,7 +6,7 @@
 
     $transactionUuid = '4c56ff4ce4aaf9573aa5dff913df997a';
 
-    $responsePayment = $ipagClient->payment()->captureByUuid($transactionUuid);
+    $responsePayment = $ipagClient->payment()->captureByUuid($transactionUuid, 50.00);
     $data = $responsePayment->getData();
 
     $statusPayment = $responsePayment->getParsedPath('attributes.status.code');
diff --git a/examples/payment/16-payment-capture-by-tid.php b/examples/payment/16-payment-capture-by-tid.php
@@ -6,7 +6,7 @@
 
     $transactionTid = 'fe79b3038e158b6e8802da5a31a557ad';
 
-    $responsePayment = $ipagClient->payment()->captureByTid($transactionTid);
+    $responsePayment = $ipagClient->payment()->captureByTid($transactionTid, 50.0);
     $data = $responsePayment->getData();
 
     $statusPayment = $responsePayment->getParsedPath('attributes.status.code');
diff --git a/examples/payment/17-payment-capture-by-order-id.php b/examples/payment/17-payment-capture-by-order-id.php
@@ -6,7 +6,7 @@
 
     $orderId = '114';
 
-    $responsePayment = $ipagClient->payment()->captureByOrderId($orderId);
+    $responsePayment = $ipagClient->payment()->captureByOrderId($orderId, 50.00);
     $data = $responsePayment->getData();
 
     $statusPayment = $responsePayment->getParsedPath('attributes.status.code');
diff --git a/examples/payment/18-payment-cancel-by-id.php b/examples/payment/18-payment-cancel-by-id.php
@@ -6,7 +6,7 @@
 
     $transactionId = 115;
 
-    $responsePayment = $ipagClient->payment()->cancelById($transactionId);
+    $responsePayment = $ipagClient->payment()->cancelById($transactionId, 50.00);
     $data = $responsePayment->getData();
 
     $statusPayment = $responsePayment->getParsedPath('attributes.status.code');
diff --git a/examples/payment/19-payment-cancel-by-uuid.php b/examples/payment/19-payment-cancel-by-uuid.php
@@ -6,7 +6,7 @@
 
     $transactionUuid = '5fd0b37cd7dbbb00f97ba6ce92bf5add';
 
-    $responsePayment = $ipagClient->payment()->cancelByUuid($transactionUuid);
+    $responsePayment = $ipagClient->payment()->cancelByUuid($transactionUuid, 50.00);
     $data = $responsePayment->getData();
 
     $statusPayment = $responsePayment->getParsedPath('attributes.status.code');
diff --git a/examples/payment/20-payment-cancel-by-tid.php b/examples/payment/20-payment-cancel-by-tid.php
@@ -6,7 +6,7 @@
 
     $transactionTid = 'b1c875a8bd263903c24d0b45751bdfba';
 
-    $responsePayment = $ipagClient->payment()->cancelByTid($transactionTid);
+    $responsePayment = $ipagClient->payment()->cancelByTid($transactionTid, 50.00);
     $data = $responsePayment->getData();
 
     $statusPayment = $responsePayment->getParsedPath('attributes.status.code');
diff --git a/examples/payment/21-payment-cancel-by-order-id.php b/examples/payment/21-payment-cancel-by-order-id.php
@@ -6,7 +6,7 @@
 
     $orderId = 124;
 
-    $responsePayment = $ipagClient->payment()->cancelByOrderId($orderId);
+    $responsePayment = $ipagClient->payment()->cancelByOrderId($orderId, 50.00);
     $data = $responsePayment->getData();
 
     $statusPayment = $responsePayment->getParsedPath('attributes.status.code');
diff --git a/src/Endpoint/PaymentEndpoint.php b/src/Endpoint/PaymentEndpoint.php
@@ -82,104 +82,112 @@ public function getByOrderId(string $orderId): Response
      * Endpoint para capturar um recurso `Payment`
      *
      * @param string $id
+     * @param ?float $amount
      * @return Response
      *
      * @codeCoverageIgnore
      */
-    public function captureById(string $id): Response
+    public function captureById(string $id, ?float $amount = null): Response
     {
-        return $this->_POST([], ['id' => $id], [], '/capture');
+        return $this->_POST([], compact('id', 'amount'), [], '/capture');
     }
 
     /**
      * Endpoint para capturar um recurso `Payment`
      *
      * @param string $uuid
+     * @param ?float $amount
      * @return Response
      *
      * @codeCoverageIgnore
      */
-    public function captureByUuid(string $uuid): Response
+    public function captureByUuid(string $uuid, ?float $amount = null): Response
     {
-        return $this->_POST([], ['uuid' => $uuid], [], '/capture');
+        return $this->_POST([], compact('uuid', 'amount'), [], '/capture');
     }
 
     /**
      * Endpoint para capturar um recurso `Payment`
      *
      * @param string $tid
+     * @param ?float $amount
      * @return Response
      *
      * @codeCoverageIgnore
      */
-    public function captureByTid(string $tid): Response
+    public function captureByTid(string $tid, ?float $amount = null): Response
     {
-        return $this->_POST([], ['tid' => $tid], [], '/capture');
+        return $this->_POST([], compact('tid', 'amount'), [], '/capture');
     }
 
     /**
      * Endpoint para capturar um recurso `Payment`
      *
-     * @param string $orderId
+     * @param string $order_id
+     * @param ?float $amount
      * @return Response
      *
      * @codeCoverageIgnore
      */
-    public function captureByOrderId(string $orderId): Response
+    public function captureByOrderId(string $order_id, ?float $amount = null): Response
     {
-        return $this->_POST([], ['order_id' => $orderId], [], '/capture');
+        return $this->_POST([], compact('order_id', 'amount'), [], '/capture');
     }
 
     /**
      * Endpoint para cancelar um recurso `Payment`
      *
      * @param string $id
+     * @param ?float $amount
      * @return Response
      *
      * @codeCoverageIgnore
      */
-    public function cancelById(string $id): Response
+    public function cancelById(string $id, ?float $amount = null): Response
     {
-        return $this->_POST([], ['id' => $id], [], '/cancel');
+        return $this->_POST([], compact('id', 'amount'), [], '/cancel');
     }
 
     /**
      * Endpoint para cancelar um recurso `Payment`
      *
      * @param string $uuid
+     * @param ?float $amount
      * @return Response
      *
      * @codeCoverageIgnore
      */
-    public function cancelByUuid(string $uuid): Response
+    public function cancelByUuid(string $uuid, ?float $amount = null): Response
     {
-        return $this->_POST([], ['uuid' => $uuid], [], '/cancel');
+        return $this->_POST([], compact('uuid', 'amount'), [], '/cancel');
     }
 
     /**
      * Endpoint para cancelar um recurso `Payment`
      *
      * @param string $tid
+     * @param ?float $amount
      * @return Response
      *
      * @codeCoverageIgnore
      */
-    public function cancelByTid(string $tid): Response
+    public function cancelByTid(string $tid, ?float $amount = null): Response
     {
-        return $this->_POST([], ['tid' => $tid], [], '/cancel');
+        return $this->_POST([], compact('tid', 'amount'), [], '/cancel');
     }
 
     /**
      * Endpoint para cancelar um recurso `Payment`
      *
-     * @param string $orderId
+     * @param string $order_id
+     * @param ?float $amount
      * @return Response
      *
      * @codeCoverageIgnore
      */
-    public function cancelByOrderId(string $orderId): Response
+    public function cancelByOrderId(string $order_id, ?float $amount = null): Response
     {
-        return $this->_POST([], ['order_id' => $orderId], [], '/cancel');
+        return $this->_POST([], compact('order_id', 'amount'), [], '/cancel');
     }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -82,104 +82,112 @@ public function getByOrderId(string $orderId): Response`
`82`	`82`	* Endpoint para capturar um recurso `Payment`
`83`	`83`	`*`
`84`	`84`	`* @param string $id`
	`85`	`+ * @param ?float $amount`
`85`	`86`	`* @return Response`
`86`	`87`	`*`
`87`	`88`	`* @codeCoverageIgnore`
`88`	`89`	`*/`
`89`		`- public function captureById(string $id): Response`
	`90`	`+ public function captureById(string $id, ?float $amount = null): Response`
`90`	`91`	`{`
`91`		`- return $this->_POST([], ['id' => $id], [], '/capture');`
	`92`	`+ return $this->_POST([], compact('id', 'amount'), [], '/capture');`
`92`	`93`	`}`
`93`	`94`
`94`	`95`	`/**`
`95`	`96`	* Endpoint para capturar um recurso `Payment`
`96`	`97`	`*`
`97`	`98`	`* @param string $uuid`
	`99`	`+ * @param ?float $amount`
`98`	`100`	`* @return Response`
`99`	`101`	`*`
`100`	`102`	`* @codeCoverageIgnore`
`101`	`103`	`*/`
`102`		`- public function captureByUuid(string $uuid): Response`
	`104`	`+ public function captureByUuid(string $uuid, ?float $amount = null): Response`
`103`	`105`	`{`
`104`		`- return $this->_POST([], ['uuid' => $uuid], [], '/capture');`
	`106`	`+ return $this->_POST([], compact('uuid', 'amount'), [], '/capture');`
`105`	`107`	`}`
`106`	`108`
`107`	`109`	`/**`
`108`	`110`	* Endpoint para capturar um recurso `Payment`
`109`	`111`	`*`
`110`	`112`	`* @param string $tid`
	`113`	`+ * @param ?float $amount`
`111`	`114`	`* @return Response`
`112`	`115`	`*`
`113`	`116`	`* @codeCoverageIgnore`
`114`	`117`	`*/`
`115`		`- public function captureByTid(string $tid): Response`
	`118`	`+ public function captureByTid(string $tid, ?float $amount = null): Response`
`116`	`119`	`{`
`117`		`- return $this->_POST([], ['tid' => $tid], [], '/capture');`
	`120`	`+ return $this->_POST([], compact('tid', 'amount'), [], '/capture');`
`118`	`121`	`}`
`119`	`122`
`120`	`123`	`/**`
`121`	`124`	* Endpoint para capturar um recurso `Payment`
`122`	`125`	`*`
`123`		`- * @param string $orderId`
	`126`	`+ * @param string $order_id`
	`127`	`+ * @param ?float $amount`
`124`	`128`	`* @return Response`
`125`	`129`	`*`
`126`	`130`	`* @codeCoverageIgnore`
`127`	`131`	`*/`
`128`		`- public function captureByOrderId(string $orderId): Response`
	`132`	`+ public function captureByOrderId(string $order_id, ?float $amount = null): Response`
`129`	`133`	`{`
`130`		`- return $this->_POST([], ['order_id' => $orderId], [], '/capture');`
	`134`	`+ return $this->_POST([], compact('order_id', 'amount'), [], '/capture');`
`131`	`135`	`}`
`132`	`136`
`133`	`137`	`/**`
`134`	`138`	* Endpoint para cancelar um recurso `Payment`
`135`	`139`	`*`
`136`	`140`	`* @param string $id`
	`141`	`+ * @param ?float $amount`
`137`	`142`	`* @return Response`
`138`	`143`	`*`
`139`	`144`	`* @codeCoverageIgnore`
`140`	`145`	`*/`
`141`		`- public function cancelById(string $id): Response`
	`146`	`+ public function cancelById(string $id, ?float $amount = null): Response`
`142`	`147`	`{`
`143`		`- return $this->_POST([], ['id' => $id], [], '/cancel');`
	`148`	`+ return $this->_POST([], compact('id', 'amount'), [], '/cancel');`
`144`	`149`	`}`
`145`	`150`
`146`	`151`	`/**`
`147`	`152`	* Endpoint para cancelar um recurso `Payment`
`148`	`153`	`*`
`149`	`154`	`* @param string $uuid`
	`155`	`+ * @param ?float $amount`
`150`	`156`	`* @return Response`
`151`	`157`	`*`
`152`	`158`	`* @codeCoverageIgnore`
`153`	`159`	`*/`
`154`		`- public function cancelByUuid(string $uuid): Response`
	`160`	`+ public function cancelByUuid(string $uuid, ?float $amount = null): Response`
`155`	`161`	`{`
`156`		`- return $this->_POST([], ['uuid' => $uuid], [], '/cancel');`
	`162`	`+ return $this->_POST([], compact('uuid', 'amount'), [], '/cancel');`
`157`	`163`	`}`
`158`	`164`
`159`	`165`	`/**`
`160`	`166`	* Endpoint para cancelar um recurso `Payment`
`161`	`167`	`*`
`162`	`168`	`* @param string $tid`
	`169`	`+ * @param ?float $amount`
`163`	`170`	`* @return Response`
`164`	`171`	`*`
`165`	`172`	`* @codeCoverageIgnore`
`166`	`173`	`*/`
`167`		`- public function cancelByTid(string $tid): Response`
	`174`	`+ public function cancelByTid(string $tid, ?float $amount = null): Response`
`168`	`175`	`{`
`169`		`- return $this->_POST([], ['tid' => $tid], [], '/cancel');`
	`176`	`+ return $this->_POST([], compact('tid', 'amount'), [], '/cancel');`
`170`	`177`	`}`
`171`	`178`
`172`	`179`	`/**`
`173`	`180`	* Endpoint para cancelar um recurso `Payment`
`174`	`181`	`*`
`175`		`- * @param string $orderId`
	`182`	`+ * @param string $order_id`
	`183`	`+ * @param ?float $amount`
`176`	`184`	`* @return Response`
`177`	`185`	`*`
`178`	`186`	`* @codeCoverageIgnore`
`179`	`187`	`*/`
`180`		`- public function cancelByOrderId(string $orderId): Response`
	`188`	`+ public function cancelByOrderId(string $order_id, ?float $amount = null): Response`
`181`	`189`	`{`
`182`		`- return $this->_POST([], ['order_id' => $orderId], [], '/cancel');`
	`190`	`+ return $this->_POST([], compact('order_id', 'amount'), [], '/cancel');`
`183`	`191`	`}`
`184`	`192`
`185`	`193`	`}`