Merge pull request #1 from t3n/manage-contact-lists

Add method to manage contacts for a given contact list
t3n · Feb 5, 2021 · dc89bcf · dc89bcf
2 parents f57d840 + 1305912
commit dc89bcf
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/Classes/Exception/InvalidManageListActionException.php b/Classes/Exception/InvalidManageListActionException.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace t3n\MailJetAdapter\Exception;
+
+use Neos\Flow\Exception;
+
+class InvalidManageListActionException extends Exception
+{
+}
diff --git a/Classes/Service/MailJetService.php b/Classes/Service/MailJetService.php
@@ -13,6 +13,7 @@
 use Neos\Flow\Property\PropertyMappingConfiguration;
 use Neos\Flow\Property\TypeConverter\DateTimeConverter;
 use Neos\Flow\Reflection\ReflectionService;
+use t3n\MailJetAdapter\Exception\InvalidManageListActionException;
 use t3n\MailJetAdapter\Exception\MailJetInvalidContactDataException;
 use t3n\MailJetAdapter\Exception\MailJetRequestException;
 use t3n\MailJetAdapter\Model\Contact;
@@ -51,6 +52,8 @@ class MailJetService
 
     protected $allowedContactMetaDataTypes = ['str', 'datetime', 'int', 'float', 'bool'];
 
+    protected $allowedManageContactListActions = ['addnoforce', 'addforce', 'remove', 'unsub'];
+
     public function getContactByEmail(MailJetContactEmail $email, bool $includeAttributes): ?Contact
     {
         return $this->fetchContact((string) $email, $includeAttributes);
@@ -124,6 +127,30 @@ public function getContactMetaData(): array
         return $this->runtimeCache['contactData'];
     }
 
+    public function manageContactListForContact(Contact $contact, int $listId, string $action = 'addnoforce'): bool
+    {
+        if (!in_array($action, $this->allowedManageContactListActions)) {
+            throw new InvalidManageListActionException(
+                sprintf(
+                    'Action %s is not a valid action to manage contact lists!
+                    Allowed actions are: %s',
+                    $action,
+                    implode(', ', $this->allowedManageContactListActions)
+                )
+            );
+        }
+
+        $response = $this->client->post(
+            Resources::$ContactManagecontactslists,
+            [
+                'id' => $contact->getIdentifier(),
+                'body' => ['ContactsLists' => [['Action' => $action, 'ListId' => $listId]]],
+            ]
+        );
+
+        return $this->parseResult($response)['count'] === 1;
+    }
+
     protected function fetchContact(string $identifier, bool $includeAttributes): ?Contact
     {
         $response = $this->client->get(Resources::$Contact, ['id' => $identifier]);