Template API (#897)

* Template API. In Progress

* Finished GET endpoint

* added endpoint for getting one template

* added create endpoint

* added create endpoint

* Style fixed

* Style fixed

* some fixes

* some fixes

* some fixes

* Add dependabot. Change php-cs-fixer

* Add dependabot. Change php-cs-fixer

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 4.2.0
+- Added basic templates functionality
+
 ## 4.0.1
  - Fix wrong classes in tests
  - Fixed response in case of 404 http error. Respect server error message

src/Api/Templates.php

@@ -0,0 +1,151 @@
+<?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\Api;
+
+use Exception;
+use Mailgun\Assert;
+use Mailgun\Model\Templates\CreateResponse;
+use Mailgun\Model\Templates\IndexResponse;
+use Mailgun\Model\Templates\ShowResponse;
+use Psr\Http\Client\ClientExceptionInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * @see https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Templates/#tag/Templates/operation/httpapi.(*TemplateAPIControler).GetPage-fm-9
+ *
+ * @author Sean Johnson <[email protected]>
+ */
+class Templates extends HttpApi
+{
+    private const PAGE_NEXT = 'next';
+    private const PAGE_FIRST = 'first';
+    private const PAGE_PREVIOUS = 'previous';
+    private const PAGE_LAST = 'last';
+
+    /**
+     * @param  string                          $domain
+     * @param  int                             $limit
+     * @param  string                          $page
+     * @param  string                          $pivot
+     * @param  array                           $requestHeaders
+     * @return IndexResponse|ResponseInterface
+     * @throws ClientExceptionInterface
+     * @throws Exception
+     */
+    public function index(string $domain, int $limit, string $page, string $pivot, array $requestHeaders = [])
+    {
+        Assert::inArray($page, [self::PAGE_LAST, self::PAGE_FIRST, self::PAGE_PREVIOUS, self::PAGE_NEXT]);
+
+        $params = [
+            'limit' => $limit,
+            'skip' => $page,
+            'p' => $pivot,
+        ];
+
+        $response = $this->httpGet(sprintf('/v3/%s/templates', $domain), $params, $requestHeaders);
+
+        return $this->hydrateResponse($response, IndexResponse::class);
+    }
+
+    /**
+     * @param  string                   $domain
+     * @param  string                   $templateId
+     * @param  array                    $requestHeaders
+     * @return mixed|ResponseInterface
+     * @throws ClientExceptionInterface
+     * @throws Exception
+     */
+    public function show(string $domain, string $templateId, array $requestHeaders = [])
+    {
+        Assert::notEmpty($domain);
+        Assert::notEmpty($templateId);
+
+        $response = $this->httpGet(sprintf('/v3/%s/templates/%s', $domain, $templateId), [], $requestHeaders);
+
+        return $this->hydrateResponse($response, ShowResponse::class);
+    }
+
+    /**
+     * @param  string                           $domain
+     * @param  string                           $name
+     * @param  string|null                      $template
+     * @param  array|null                       $headers
+     * @param  string|null                      $tag
+     * @param  string|null                      $comment
+     * @param  string|null                      $createdBy
+     * @param  string|null                      $description
+     * @param  string|null                      $engine
+     * @param  array                            $requestHeaders
+     * @return CreateResponse|ResponseInterface
+     * @throws ClientExceptionInterface
+     * @throws Exception
+     */
+    public function create(
+        string $domain,
+        string $name,
+        ?string $template = null,
+        ?array $headers = null,
+        ?string $tag = null,
+        ?string $comment = null,
+        ?string $createdBy = null,
+        ?string $description = null,
+        ?string $engine = null,
+        array $requestHeaders = []
+    ) {
+        Assert::stringNotEmpty($domain);
+        Assert::stringNotEmpty($name);
+
+        $body = [
+            'name' => $name,
+        ];
+
+        if (!empty($template)) {
+            $body['template'] = $template;
+        }
+        if (!empty($tag)) {
+            $body['tag'] = $tag;
+        }
+        if (!empty($comment)) {
+            $body['comment'] = $comment;
+        }
+        if (!empty($createdBy)) {
+            $body['createdBy'] = $createdBy;
+        }
+        if (!empty($headers)) {
+            $body['headers'] = json_encode($headers);
+        }
+        if (!empty($description)) {
+            $body['description'] = $description;
+        }
+        if (!empty($engine)) {
+            $body['engine'] = $engine;
+        }
+
+        $response = $this->httpPost(sprintf('/v3/%s/templates', $domain), $body, $requestHeaders);
+
+        return $this->hydrateResponse($response, CreateResponse::class);
+    }
+
+    /**
+     * @param  string                   $domain
+     * @param  string                   $templateName
+     * @param  array                    $requestHeaders
+     * @return mixed|ResponseInterface
+     * @throws ClientExceptionInterface
+     */
+    public function deleteTemplate(string $domain, string $templateName, array $requestHeaders = [])
+    {
+        $response = $this->httpDelete(sprintf('/v3/%s/templates/%s', $domain, $templateName), [], $requestHeaders);
+
+        return $this->hydrateResponse($response, ShowResponse::class);
+    }
+}

src/Mailgun.php

@@ -24,8 +24,10 @@
 use Mailgun\Api\Message;
 use Mailgun\Api\Route;
 use Mailgun\Api\Stats;
+use Mailgun\Api\SubAccounts;
 use Mailgun\Api\Suppression;
 use Mailgun\Api\Tag;
+use Mailgun\Api\Templates;
 use Mailgun\Api\Webhook;
 use Mailgun\HttpClient\HttpClientConfigurator;
 use Mailgun\HttpClient\Plugin\History;
@@ -229,8 +231,19 @@ public function httpClient(): Api\HttpClient
         return new Api\HttpClient($this->httpClient, $this->requestBuilder, $this->hydrator);
     }
 
+    /**
+     * @return SubAccounts
+     */
     public function subaccounts(): Api\SubAccounts
     {
         return new Api\SubAccounts($this->httpClient, $this->requestBuilder, $this->hydrator);
     }
+
+    /**
+     * @return Templates
+     */
+    public function templates(): Templates
+    {
+        return new Templates($this->httpClient, $this->requestBuilder, $this->hydrator);
+    }
 }

src/Model/Templates/CreateResponse.php

@@ -0,0 +1,59 @@
+<?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\Templates;
+
+use Mailgun\Model\ApiResponse;
+
+final class CreateResponse implements ApiResponse
+{
+    private $message;
+
+    /**
+     * @var Template
+     */
+    private $template;
+
+    /**
+     * @param  array  $data
+     * @return static
+     */
+    public static function create(array $data): self
+    {
+        $model = new self();
+        $model->message = $data['message'] ?? null;
+        if (isset($data['template'])) {
+            $model->template = Template::create($data['template']);
+        }
+
+        return $model;
+    }
+
+    private function __construct()
+    {
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getMessage(): ?string
+    {
+        return $this->message;
+    }
+
+    /**
+     * @return Template|null
+     */
+    public function getTemplate(): ?Template
+    {
+        return $this->template;
+    }
+}

src/Model/Templates/DeleteResponse.php

@@ -0,0 +1,73 @@
+<?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\Templates;
+
+use Mailgun\Model\ApiResponse;
+
+final class DeleteResponse implements ApiResponse
+{
+    /**
+     * @var string
+     */
+    private $message;
+
+    /**
+     * @var Template
+     */
+    private $template;
+
+    /**
+     * @param  array  $data
+     * @return static
+     */
+    public static function create(array $data): self
+    {
+        $template = $data['template'] ?? $data;
+        $model = new self();
+        $model->setMessage($data['message']);
+        $model->setTemplate(Template::create($template));
+
+        return $model;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+
+    /**
+     * @param string $message
+     */
+    public function setMessage(string $message): void
+    {
+        $this->message = $message;
+    }
+
+    /**
+     * @return Template
+     */
+    public function getTemplate(): Template
+    {
+        return $this->template;
+    }
+
+    /**
+     * @param Template $template
+     */
+    public function setTemplate(Template $template): void
+    {
+        $this->template = $template;
+    }
+}