add duplicate service and tests

Signed-off-by: mesilov <mesilov.maxim@gmail.com>

CHANGELOG.md

@@ -18,7 +18,8 @@
   * `Bitrix24\SDK\Services\User\Service\User::get` - get user
   * `Bitrix24\SDK\Services\User\Service\User::update` - update user
   * `Bitrix24\SDK\Services\User\Service\User::search` - search users
-* add [crm item support](https://github.com/mesilov/bitrix24-php-sdk/issues/330) 
+* add [crm item support](https://github.com/mesilov/bitrix24-php-sdk/issues/330)
+* add Duplicate search support for `Bitrix24\SDK\Services\CRM\Duplicates\Service\Duplicate`
 
 ### Changed
 

src/Services/CRM/CRMServiceBuilder.php

@@ -183,4 +183,16 @@ public function item(): Item\Service\Item
 
         return $this->serviceCache[__METHOD__];
     }
+
+    public function duplicate(): Duplicates\Service\Duplicate
+    {
+        if (!isset($this->serviceCache[__METHOD__])) {
+            $this->serviceCache[__METHOD__] = new Duplicates\Service\Duplicate(
+                $this->core,
+                $this->log
+            );
+        }
+
+        return $this->serviceCache[__METHOD__];
+    }
 }

src/Services/CRM/Duplicates/Result/DuplicateResult.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Duplicates\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+class DuplicateResult extends AbstractResult
+{
+    public function hasDuplicateContacts(): bool
+    {
+        if (!array_key_exists('CONTACT', $this->getCoreResponse()->getResponseData()->getResult())) {
+            return false;
+        }
+
+        if (count($this->getCoreResponse()->getResponseData()->getResult()['CONTACT']) > 1) {
+            return true;
+        }
+
+        return false;
+    }
+
+    public function hasOneContact(): bool
+    {
+        if (!array_key_exists('CONTACT', $this->getCoreResponse()->getResponseData()->getResult())) {
+            return false;
+        }
+
+        if (count($this->getCoreResponse()->getResponseData()->getResult()['CONTACT']) === 1) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @return array<int>
+     * @throws BaseException
+     */
+    public function getContactsId(): array
+    {
+        if (!array_key_exists('CONTACT', $this->getCoreResponse()->getResponseData()->getResult())) {
+            return [];
+        }
+
+        return $this->getCoreResponse()->getResponseData()->getResult()['CONTACT'];
+    }
+}

src/Services/CRM/Duplicates/Service/Duplicate.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Duplicates\Service;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Exceptions\TransportException;
+use Bitrix24\SDK\Services\AbstractService;
+use Bitrix24\SDK\Services\CRM\Duplicates\Result\DuplicateResult;
+
+class Duplicate extends AbstractService
+{
+    /**
+     * @param array<string> $phones
+     * @param EntityType|null $entityType
+     * @return DuplicateResult
+     * @throws BaseException
+     * @throws TransportException
+     */
+    public function findByPhone(array $phones, ?EntityType $entityType = null): mixed
+    {
+        return new DuplicateResult($this->core->call('crm.duplicate.findbycomm',
+            [
+                'type' => 'PHONE',
+                'values' => $phones,
+                'entity_type' => $entityType?->value
+            ]));
+    }
+
+    /**
+     * @param array<string> $emails
+     * @param EntityType|null $entityType
+     * @return DuplicateResult
+     * @throws BaseException
+     * @throws TransportException
+     */
+    public function findByEmail(array $emails, ?EntityType $entityType = null): DuplicateResult
+    {
+        return new DuplicateResult($this->core->call('crm.duplicate.findbycomm',
+            [
+                'type' => 'EMAIL',
+                'values' => $emails,
+                'entity_type' => $entityType?->value
+            ]));
+    }
+}

src/Services/CRM/Duplicates/Service/EntityType.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Duplicates\Service;
+
+enum EntityType: string
+{
+    case Lead = 'LEAD';
+    case Contact = 'CONTACT';
+    case Company = 'COMPANY';
+}

tests/Integration/Services/CRM/Duplicates/Service/DuplicateTest.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Tests\Integration\Services\CRM\Duplicates\Service;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Exceptions\TransportException;
+use Bitrix24\SDK\Services\CRM\Contact\Service\Contact;
+use Bitrix24\SDK\Services\CRM\Duplicates\Service\Duplicate;
+use Bitrix24\SDK\Tests\Integration\Fabric;
+use PHPUnit\Framework\TestCase;
+
+class DuplicateTest extends TestCase
+{
+    protected Contact $contactService;
+    protected Duplicate $duplicate;
+
+    /**
+     * @return void
+     * @throws BaseException
+     * @throws TransportException
+     * @covers \Bitrix24\SDK\Services\CRM\Duplicates\Service\Duplicate::findByEmail
+     */
+    public function testDuplicatesByEmailNotFound(): void
+    {
+        $res = $this->duplicate->findByEmail([sprintf('%s@gmail.com', time())]);
+        $this->assertFalse($res->hasDuplicateContacts());
+        $this->assertFalse($res->hasOneContact());
+        $this->assertCount(0, $res->getContactsId());
+    }
+
+    /**
+     * @return void
+     * @throws BaseException
+     * @throws TransportException
+     * @covers \Bitrix24\SDK\Services\CRM\Duplicates\Service\Duplicate::findByEmail
+     */
+    public function testDuplicatesByEmailOneItemFound(): void
+    {
+        $email = sprintf('%s@gmail.com', time());
+        $b24ContactId = $this->contactService->add([
+            'NAME' => 'Test',
+            'LAST_NAME' => 'Test',
+            'EMAIL' => [
+                [
+                    'VALUE' => $email,
+                    'TYPE' => 'WORK'
+                ]
+            ]
+        ])->getId();
+
+        $res = $this->duplicate->findByEmail([$email]);
+        $this->assertFalse($res->hasDuplicateContacts());
+        $this->assertTrue($res->hasOneContact());
+        $this->assertCount(1, $res->getContactsId());
+    }
+
+    /**
+     * @return void
+     * @throws BaseException
+     * @throws TransportException
+     * @covers \Bitrix24\SDK\Services\CRM\Duplicates\Service\Duplicate::findByPhone
+     */
+    public function testDuplicatesByPhoneNotFound(): void
+    {
+        $res = $this->duplicate->findByPhone([sprintf('+1%s', time())]);
+        $this->assertFalse($res->hasDuplicateContacts());
+        $this->assertFalse($res->hasOneContact());
+        $this->assertCount(0, $res->getContactsId());
+    }
+
+
+    public function setUp(): void
+    {
+        $this->contactService = Fabric::getServiceBuilder()->getCRMScope()->contact();
+        $this->duplicate = Fabric::getServiceBuilder()->getCRMScope()->duplicate();
+
+    }
+}

tests/Unit/Stubs/NullBatch.php

@@ -18,9 +18,15 @@ class NullBatch implements BatchOperationsInterface
 {
 
     /**
+     * @param string $apiMethod
+     * @param array $order
+     * @param array $filter
+     * @param array $select
+     * @param int|null $limit
+     * @param array|null $additionalParameters
      * @inheritDoc
      */
-    public function getTraversableList(string $apiMethod, array $order, array $filter, array $select, ?int $limit = null): Generator
+    public function getTraversableList(string $apiMethod, array $order, array $filter, array $select, ?int $limit = null, ?array $additionalParameters = null): Generator
     {
         yield [];
     }