Merge pull request #289 from bitrix24/feature/288-add-crm-on-contact-events

Add support for CRM Contact events: `onCrmContactAdd`, `onCrmContactU…

Author: mesilov

CHANGELOG.md

@@ -13,8 +13,10 @@
   - `list` Get a list of custom types crm.type.list
   - `delete` This method deletes an existing smart process by the identifier id
 - For `AbstractCrmItem` added method `getSmartProcessItem` to get smart process item, [see details](https://github.com/bitrix24/b24phpsdk/issues/282)
-
-
+- Added support for events, [see details](https://github.com/bitrix24/b24phpsdk/issues/288)  
+  - `onCrmContactAdd`
+  - `onCrmContactUpdate`
+  - `onCrmContactDelete`
 
 ### Fixed
 

src/Services/CRM/Contact/Events/CrmContactEventsFactory.php

@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <[email protected]>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Contact\Events;
+
+use Bitrix24\SDK\Core\Contracts\Events\EventInterface;
+use Bitrix24\SDK\Core\Contracts\Events\EventsFabricInterface;
+use Bitrix24\SDK\Core\Exceptions\InvalidArgumentException;
+use Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactAdd\OnCrmContactAdd;
+use Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactDelete\OnCrmContactDelete;
+use Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactUpdate\OnCrmContactUpdate;
+use Symfony\Component\HttpFoundation\Request;
+
+readonly class CrmContactEventsFactory implements EventsFabricInterface
+{
+    public function isSupport(string $eventCode): bool
+    {
+        return in_array(strtoupper($eventCode), [
+            OnCrmContactAdd::CODE,
+            OnCrmContactUpdate::CODE,
+            OnCrmContactDelete::CODE,
+        ], true);
+    }
+
+    /**
+     * @throws InvalidArgumentException
+     */
+    public function create(Request $eventRequest): EventInterface
+    {
+        $eventPayload = $eventRequest->request->all();
+        if (!array_key_exists('event', $eventPayload)) {
+            throw new InvalidArgumentException('«event» key not found in event payload');
+        }
+
+        return match ($eventPayload['event']) {
+            OnCrmContactAdd::CODE => new OnCrmContactAdd($eventRequest),
+            OnCrmContactUpdate::CODE => new OnCrmContactUpdate($eventRequest),
+            OnCrmContactDelete::CODE => new OnCrmContactDelete($eventRequest),
+            default => throw new InvalidArgumentException(
+                sprintf('Unexpected event code «%s»', $eventPayload['event'])
+            ),
+        };
+    }
+}

src/Services/CRM/Contact/Events/OnCrmContactAdd/OnCrmContactAdd.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <[email protected]>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactAdd;
+
+use Bitrix24\SDK\Application\Requests\Events\AbstractEventRequest;
+
+class OnCrmContactAdd extends AbstractEventRequest
+{
+    public const CODE = 'ONCRMCONTACTADD';
+
+    public function getPayload(): OnCrmContactAddPayload
+    {
+        return new OnCrmContactAddPayload($this->eventPayload['data']);
+    }
+}

src/Services/CRM/Contact/Events/OnCrmContactAdd/OnCrmContactAddPayload.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <[email protected]>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactAdd;
+
+use Bitrix24\SDK\Core\Result\AbstractItem;
+
+/**
+ * @property-read  positive-int $ID
+ */
+class OnCrmContactAddPayload extends AbstractItem
+{
+}

src/Services/CRM/Contact/Events/OnCrmContactDelete/OnCrmContactDelete.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <[email protected]>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactDelete;
+
+use Bitrix24\SDK\Application\Requests\Events\AbstractEventRequest;
+
+class OnCrmContactDelete extends AbstractEventRequest
+{
+    public const CODE = 'ONCRMCONTACTDELETE';
+
+    public function getPayload(): OnCrmContactDeletePayload
+    {
+        return new OnCrmContactDeletePayload($this->eventPayload['data']);
+    }
+}

src/Services/CRM/Contact/Events/OnCrmContactDelete/OnCrmContactDeletePayload.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <[email protected]>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactDelete;
+
+use Bitrix24\SDK\Core\Result\AbstractItem;
+
+/**
+ * @property-read  positive-int $ID
+ */
+class OnCrmContactDeletePayload extends AbstractItem
+{
+}

src/Services/CRM/Contact/Events/OnCrmContactUpdate/OnCrmContactUpdate.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <[email protected]>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactUpdate;
+
+use Bitrix24\SDK\Application\Requests\Events\AbstractEventRequest;
+
+class OnCrmContactUpdate extends AbstractEventRequest
+{
+    public const CODE = 'ONCRMCONTACTUPDATE';
+
+    public function getPayload(): OnCrmContactUpdatePayload
+    {
+        return new OnCrmContactUpdatePayload($this->eventPayload['data']);
+    }
+}

src/Services/CRM/Contact/Events/OnCrmContactUpdate/OnCrmContactUpdatePayload.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <[email protected]>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Contact\Events\OnCrmContactUpdate;
+
+use Bitrix24\SDK\Core\Result\AbstractItem;
+
+/**
+ * @property-read  positive-int $ID
+ */
+class OnCrmContactUpdatePayload extends AbstractItem
+{
+}

src/Services/RemoteEventsFactory.php

@@ -23,6 +23,7 @@
 use Bitrix24\SDK\Core\Requests\Events\UnsupportedRemoteEvent;
 use Bitrix24\SDK\Services\Calendar\Events\CalendarEventsFactory;
 use Bitrix24\SDK\Services\CRM\Company\Events\CrmCompanyEventsFactory;
+use Bitrix24\SDK\Services\CRM\Contact\Events\CrmContactEventsFactory;
 use Bitrix24\SDK\Services\Sale;
 use Bitrix24\SDK\Services\Telephony\Events\TelephonyEventsFabric;
 use Bitrix24\SDK\Services\Telephony\Events\TelephonyEventsFactory;
@@ -150,6 +151,7 @@ public static function init(LoggerInterface $logger): self
                 new TelephonyEventsFactory(),
                 new CalendarEventsFactory(),
                 new CrmCompanyEventsFactory(),
+                new CrmContactEventsFactory(),
                 new Sale\Events\SaleEventsFactory(),
             ],
             $logger