add lead support

CHANGELOG.md

@@ -1,6 +1,11 @@
 # bitrix24-php-sdk change log
 
-## 2.0-alpha.6 — 7.02.2021
+## 2.0-alpha.7 — 7.05.2022
+
+### Added
+* add `Leads` [добавить поддержку лидов](https://github.com/mesilov/bitrix24-php-sdk/issues/282)
+
+## 2.0-alpha.6 — 7.02.2022
 
 ### Added
 

src/Services/CRM/CRMServiceBuilder.php

@@ -170,4 +170,20 @@ public function userfield(): Userfield\Service\Userfield
 
         return $this->serviceCache[__METHOD__];
     }
+
+    /**
+     * @return Lead\Service\Lead
+     */
+    public function lead(): Lead\Service\Lead
+    {
+        if (!isset($this->serviceCache[__METHOD__])) {
+            $this->serviceCache[__METHOD__] = new Lead\Service\Lead(
+                new Lead\Service\Batch($this->batch, $this->log),
+                $this->core,
+                $this->log
+            );
+        }
+
+        return $this->serviceCache[__METHOD__];
+    }
 }

src/Services/CRM/Lead/Result/LeadItemResult.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Lead\Result;
+
+use Bitrix24\SDK\Services\CRM\Common\Result\AbstractCrmItem;
+use DateTimeInterface;
+
+/**
+ * Class LeadItemResult
+ *
+ * @property-read int                    $ID
+ * @property-read string                 $TITLE
+ * @property-read string                 $HONORIFIC
+ * @property-read string                 $NAME
+ * @property-read string                 $SECOND_NAME
+ * @property-read string                 $LAST_NAME
+ * @property-read DateTimeInterface|null $BIRTHDATE
+ * @property-read string                 $COMPANY_TITLE
+ * @property-read string                 $SOURCE_ID
+ * @property-read string                 $SOURCE_DESCRIPTION
+ * @property-read string                 $STATUS_ID
+ * @property-read string                 $STATUS_DESCRIPTION
+ * @property-read string                 $STATUS_SEMANTIC_ID
+ * @property-read string                 $POST
+ * @property-read string                 $ADDRESS
+ * @property-read string                 $ADDRESS_2
+ * @property-read string                 $ADDRESS_CITY
+ * @property-read string                 $ADDRESS_POSTAL_CODE
+ * @property-read string                 $ADDRESS_REGION
+ * @property-read string                 $ADDRESS_PROVINCE
+ * @property-read string                 $ADDRESS_COUNTRY
+ * @property-read string                 $ADDRESS_COUNTRY_CODE
+ * @property-read int                    $ADDRESS_LOC_ADDR_ID
+ * @property-read string                 $CURRENCY_ID
+ * @property-read string                 $OPPORTUNITY
+ * @property-read string                 $IS_MANUAL_OPPORTUNITY
+ * @property-read string                 $OPENED
+ * @property-read string                 $COMMENTS
+ * @property-read string                 $HAS_PHONE
+ * @property-read string                 $HAS_EMAIL
+ * @property-read string                 $HAS_IMOL
+ * @property-read string                 $ASSIGNED_BY_ID
+ * @property-read string                 $CREATED_BY_ID
+ * @property-read string                 $MODIFY_BY_ID
+ * @property-read string                 $MOVED_BY_ID
+ * @property-read string                 $DATE_CREATE
+ * @property-read string                 $DATE_MODIFY
+ * @property-read string                 $MOVED_TIME
+ * @property-read string                 $COMPANY_ID
+ * @property-read string                 $CONTACT_ID
+ * @property-read string                 $CONTACT_IDS
+ * @property-read string                 $IS_RETURN_CUSTOMER
+ * @property-read string                 $DATE_CLOSED
+ * @property-read string                 $ORIGINATOR_ID
+ * @property-read string                 $ORIGIN_ID
+ * @property-read string                 $UTM_SOURCE
+ * @property-read string                 $UTM_MEDIUM
+ * @property-read string                 $UTM_CAMPAIGN
+ * @property-read string                 $UTM_CONTENT
+ * @property-read string                 $UTM_TERM
+ * @property-read string                 $PHONE
+ * @property-read string                 $EMAIL
+ * @property-read string                 $WEB
+ * @property-read string                 $IM
+ * @property-read string                 $LINK
+ */
+class LeadItemResult extends AbstractCrmItem
+{
+    /**
+     * @param string $userfieldName
+     *
+     * @return mixed|null
+     * @throws \Bitrix24\SDK\Services\CRM\Userfield\Exceptions\UserfieldNotFoundException
+     */
+    public function getUserfieldByFieldName(string $userfieldName)
+    {
+        return $this->getKeyWithUserfieldByFieldName($userfieldName);
+    }
+}

src/Services/CRM/Lead/Result/LeadResult.php

@@ -0,0 +1,24 @@
+<?php
+
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Lead\Result;
+
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class LeadResult
+ *
+ * @package Bitrix24\SDK\Services\CRM\Lead\Result
+ */
+class LeadResult extends AbstractResult
+{
+    /**
+     * @throws \Bitrix24\SDK\Core\Exceptions\BaseException
+     */
+    public function lead(): LeadItemResult
+    {
+        return new LeadItemResult($this->getCoreResponse()->getResponseData()->getResult()->getResultData());
+    }
+}

src/Services/CRM/Lead/Result/LeadsResult.php

@@ -0,0 +1,31 @@
+<?php
+
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Lead\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class LeadsResult
+ *
+ * @package Bitrix24\SDK\Services\CRM\Lead\Result
+ */
+class LeadsResult extends AbstractResult
+{
+    /**
+     * @return LeadItemResult[]
+     * @throws BaseException
+     */
+    public function getLeads(): array
+    {
+        $items = [];
+        foreach ($this->getCoreResponse()->getResponseData()->getResult()->getResultData() as $item) {
+            $items[] = new LeadItemResult($item);
+        }
+
+        return $items;
+    }
+}