Support updating CNAME used for tracking opens and clicks

src/Api/Domain.php

@@ -29,6 +29,7 @@
 use Mailgun\Model\Domain\UpdateUnsubscribeTrackingResponse;
 use Mailgun\Model\Domain\VerifyResponse;
 use Mailgun\Model\Domain\WebSchemeResponse;
+use Mailgun\Model\Domain\WebPrefixResponse;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Message\ResponseInterface;
 
@@ -468,4 +469,27 @@ public function updateUnsubscribeTracking(string $domain, string $active, string
 
         return $this->hydrateResponse($response, UpdateUnsubscribeTrackingResponse::class);
     }
+
+    /**
+     * Updates a CNAME used for tracking opens and clicks.
+     *
+     * @param string $domain    The name of the domain
+     * @param string $webPrefix The tracking CNAME for a domain
+     *
+     * @return WebPrefixResponse|array|ResponseInterface
+     * @throws ClientExceptionInterface
+     */
+    public function updateWebPrefix(string $domain, string $webPrefix)
+    {
+        Assert::stringNotEmpty($domain);
+        Assert::stringNotEmpty($webPrefix);
+
+        $params = [
+            'web_prefix' => $webPrefix,
+        ];
+
+        $response = $this->httpPut(sprintf('/v3/domains/%s/web_prefix', $domain), $params);
+
+        return $this->hydrateResponse($response, WebPrefixResponse::class);
+    }
 }

src/Model/Domain/WebPrefixResponse.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (C) 2013 Mailgun
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+
+namespace Mailgun\Model\Domain;
+
+final class WebPrefixResponse extends AbstractDomainResponse
+{
+}

tests/Api/DomainTest.php

@@ -27,6 +27,7 @@
 use Mailgun\Model\Domain\UpdateOpenTrackingResponse;
 use Mailgun\Model\Domain\UpdateUnsubscribeTrackingResponse;
 use Mailgun\Model\Domain\VerifyResponse;
+use Mailgun\Model\Domain\WebPrefixResponse;
 use Nyholm\Psr7\Response;
 
 class DomainTest extends TestCase
@@ -491,4 +492,22 @@ public function testUpdateUnsubscribeTrackingException()
         $api = $this->getApiInstance();
         $api->updateUnsubscribeTracking('example.com', 'non-valid-active-param', 'html-footer', 'text-footer');
     }
+
+    public function testUpdateWebPrefix()
+    {
+        $this->setRequestMethod('PUT');
+        $this->setRequestUri('/v3/domains/example.com/web_prefix');
+        $this->setRequestBody(
+            [
+            'web_prefix' => 'tracking',
+            ]
+        );
+        $this->setHydrateClass(WebPrefixResponse::class);
+
+        /**
+         * @var Domain
+         */
+        $api = $this->getApiInstance();
+        $api->updateWebPrefix('example.com', 'tracking');
+    }
 }

tests/Model/Domain/WebPrefixResponseTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (C) 2013 Mailgun
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+
+namespace Mailgun\Tests\Model\Domain;
+
+use Mailgun\Model\Domain\ClickTracking;
+use Mailgun\Model\Domain\WebPrefixResponse;
+use Mailgun\Tests\Model\BaseModelTest;
+
+class WebPrefixResponseTest extends BaseModelTest
+{
+    public function testCreate()
+    {
+        $json =
+            <<<'JSON'
+{
+  "message": "Domain web prefix updated"
+}
+JSON;
+        $model = WebPrefixResponse::create(json_decode($json, true));
+        $this->assertNotEmpty($model->getMessage());
+    }
+}