feat(Payment): support key for payments

Closes #315

Author: Jens Schulze

src/Core/Model/Payment/Payment.php

@@ -50,6 +50,8 @@
  * @method Payment setTransactions(TransactionCollection $transactions = null)
  * @method CustomFieldObjectCollection getInterfaceInteractions()
  * @method Payment setInterfaceInteractions(CustomFieldObjectCollection $interfaceInteractions = null)
+ * @method string getKey()
+ * @method Payment setKey(string $key = null)
  * @method PaymentReference getReference()
  */
 class Payment extends Resource
@@ -59,6 +61,7 @@ public function fieldDefinitions()
         return [
             'id' => [static::TYPE => 'string'],
             'version' => [static::TYPE => 'int'],
+            'key' => [static::TYPE => 'string'],
             'createdAt' => [
                 static::TYPE => DateTime::class,
                 static::DECORATOR => DateTimeDecorator::class

src/Core/Model/Payment/PaymentDraft.php

@@ -44,12 +44,15 @@
  * @method PaymentDraft setTransactions(TransactionCollection $transactions = null)
  * @method CustomFieldObjectDraftCollection getInterfaceInteractions()
  * @method PaymentDraft setInterfaceInteractions(CustomFieldObjectDraftCollection $interfaceInteractions = null)
+ * @method string getKey()
+ * @method PaymentDraft setKey(string $key = null)
  */
 class PaymentDraft extends JsonObject
 {
     public function fieldDefinitions()
     {
         return [
+            'key' => [static::TYPE => 'string'],
             'customer' => [static::TYPE => CustomerReference::class],
             'externalId' => [static::TYPE => 'string'],
             'interfaceId' => [static::TYPE => 'string'],

src/Core/Request/Payments/Command/PaymentSetKeyAction.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * @author @jayS-de <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Request\Payments\Command;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractAction;
+use Commercetools\Core\Model\Common\Money;
+
+/**
+ * @package Commercetools\Core\Request\Payments\Command
+ * @link https://dev.commercetools.com/http-api-projects-payments.html#set-key
+ * @method string getAction()
+ * @method PaymentSetKeyAction setAction(string $action = null)
+ * @method string getKey()
+ * @method PaymentSetKeyAction setKey(string $key = null)
+ */
+class PaymentSetKeyAction extends AbstractAction
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'action' => [static::TYPE => 'string'],
+            'key' => [static::TYPE => 'string'],
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     */
+    public function __construct(array $data = [], $context = null)
+    {
+        parent::__construct($data, $context);
+        $this->setAction('setKey');
+    }
+}

tests/integration/Payment/PaymentUpdateRequestTest.php

@@ -29,6 +29,7 @@
 use Commercetools\Core\Request\Payments\Command\PaymentSetCustomTypeAction;
 use Commercetools\Core\Request\Payments\Command\PaymentSetExternalIdAction;
 use Commercetools\Core\Request\Payments\Command\PaymentSetInterfaceIdAction;
+use Commercetools\Core\Request\Payments\Command\PaymentSetKeyAction;
 use Commercetools\Core\Request\Payments\Command\PaymentSetMethodInfoInterfaceAction;
 use Commercetools\Core\Request\Payments\Command\PaymentSetMethodInfoMethodAction;
 use Commercetools\Core\Request\Payments\Command\PaymentSetMethodInfoNameAction;
@@ -112,6 +113,29 @@ public function testSetCustomer()
         $this->assertNotSame($payment->getVersion(), $result->getVersion());
     }
 
+    public function testSetKey()
+    {
+        $key = $this->getTestRun() . '-key';
+        $draft = $this->getDraft();
+        $draft->setKey($key);
+        $payment = $this->createPayment($draft);
+        $this->assertSame($key, $payment->getKey());
+
+        $key = $this->getTestRun() . '-new-key';
+        $request = PaymentUpdateRequest::ofIdAndVersion($payment->getId(), $payment->getVersion())
+            ->addAction(
+                PaymentSetKeyAction::of()->setKey($key)
+            )
+        ;
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertInstanceOf(Payment::class, $result);
+        $this->assertSame($key, $result->getKey());
+        $this->assertNotSame($payment->getVersion(), $result->getVersion());
+    }
+
     public function testSetExternalId()
     {
         $draft = $this->getDraft();