add deal category stages

Author: mesilov

CHANGELOG.md

@@ -1,19 +1,37 @@
 # bitrix24-php-sdk change log
-## 2.0 DEV
-* remove all old code
+
+## 2.0-alpha.2 (31.01.2021)
+
+* remove Travis CI and migrate to Github Actions
+* add unit-tests
+* add phpstan checks in independent github action
+* add in scope «CRM» Contacts service and integration test
+* add in scope «CRM» Contacts batch service and integration test
+* add in scope «CRM» Products service and integration test
+* add in scope «CRM» Settings service and integration test
+* add in scope «CRM» DealCategoryStage service and integration test
+* add in scope «IM» IM service and integration test
+* add in default scope «Main» default service
+
+## 2.0-alpha.1 (11.07.2020)
+
+* remove all v1 code
 * migrate to Symfony HttpClient
 * add documentation webhook auth type
 * add OAuth 2.0 support
 * add Events support
 
 ## 0.7.0 (11.07.2020)
+
 * add arguments in method `Bitrix24\Bizproc\Robot::add` for return results support
 
 ## 0.6.2 (12.09.2019)
+
 * remove in method, `processBatchCalls` remove call `handleBitrix24APILevelErrors`
 * remove php 5.x branch in travis config
 
 ## 0.6.1 (20.03.2019)
+
 * add `offset` parameter to entity `CRM\Status\Status` in method `getList`
 * add `offset` parameter to entity `User\User` in method `getList`
 * add method `messageAdd` to entity `Bitrix24\Bitrix24`
@@ -26,8 +44,9 @@
 * fix log level in method `Bitrix24::handleBitrix24APILevelErrors`
 
 ## 0.6.0 (18.02.2018)
+
 * add support for `FaceTracker` entity
-* add presets for request timing information 
+* add presets for request timing information
 * add all methods for sonetgroup
 * add method `crm.contact.userfield.update`
 * add activities methods
@@ -44,39 +63,51 @@
 * add new placement presets for detail page
 
 ## 0.5.4 (8.07.2017)
+
 * add Callback for expired token. Fix pullrequest#63 by valga
 * add method `update` in class `Bitrix24\CRM\Product`
 * increased curl time out
 * add new scope `placement` in class `Bitrix24\Presets\Scope`
 * add batch calls method to bitrix24 api client interface
 
 ## 0.5.3 (20.05.2017)
+
 * add class `Bitrix24\Placement\Placement`
 * add preset `Bitrix24\Presets\Placement\Placement` with placement codes
 * add preset `Bitrix24\Presets\Placement\Fields` with placement fields
 
 ## 0.5.2 (11.05.2017)
+
 * add preset `Bitrix24\Presets\CRM\Product\ProductRowFields`
 * updated preset `Bitrix24\Presets\CRM\Contact\Fields`
 * updated preset `Bitrix24\Presets\CRM\Deal\Fields`
 * updated preset `Bitrix24\Presets\CRM\Lead\Fields`
 
 ## 0.5.1 (30.04.2017)
+
 * add preset `Bitrix24\Presets\CRM\Product\Fields`
 * add method `add` in class `Bitrix24\CRM\Product`
 
 ## 0.5.0 (4.09.2016)
+
 * add class `Bitrix24\CRM\Quote` see pr [Added support for Quote API calls](https://github.com/mesilov/bitrix24-php-sdk/pull/53/)
-* add support http status 301 moved permanently in class `Bitrix24` see issue [301 Moved Permanently #49](https://github.com/mesilov/bitrix24-php-sdk/issues/49)
+* add support http status 301 moved permanently in class `Bitrix24` see
+  issue [301 Moved Permanently #49](https://github.com/mesilov/bitrix24-php-sdk/issues/49)
 * fixed bug in class `Bitrix24` see pr [Issue in the isAccessTokenExpire method](https://github.com/mesilov/bitrix24-php-sdk/pull/54)
 
 ## 0.4.1 (4.08.2016)
-* add new events in class `Bitrix24\Presets\Event\Event` see issue [Add new bitrix24 events #44](https://github.com/mesilov/bitrix24-php-sdk/issues/44) 
-* add new scope in class `Bitrix24\Presets\Scope` see issue [Update scope presets class #47](https://github.com/mesilov/bitrix24-php-sdk/issues/47)
-* remove file with old deprecated exceptions see issue [Move all exceptions in namespace «Exceptions» #46](https://github.com/mesilov/bitrix24-php-sdk/issues/46)
+
+* add new events in class `Bitrix24\Presets\Event\Event` see
+  issue [Add new bitrix24 events #44](https://github.com/mesilov/bitrix24-php-sdk/issues/44)
+* add new scope in class `Bitrix24\Presets\Scope` see
+  issue [Update scope presets class #47](https://github.com/mesilov/bitrix24-php-sdk/issues/47)
+* remove file with old deprecated exceptions see
+  issue [Move all exceptions in namespace «Exceptions» #46](https://github.com/mesilov/bitrix24-php-sdk/issues/46)
 
 ## 0.4.0 (16.07.2016)
-* remove all exceptions in namespace `\Exceptions` see issue [Move all exceptions in namespace «Exceptions» #46](https://github.com/mesilov/bitrix24-php-sdk/issues/46)
+
+* remove all exceptions in namespace `\Exceptions` see
+  issue [Move all exceptions in namespace «Exceptions» #46](https://github.com/mesilov/bitrix24-php-sdk/issues/46)
 * add class `Bitrix24\Exceptions\Bitrix24Exception`
 * add class `Bitrix24\Exceptions\Bitrix24IoException`
 * add class `Bitrix24\Exceptions\Bitrix24EmptyResponseException`
@@ -100,37 +131,48 @@
 * updated class `Bitrix24\Bitrix24SecurityException` mark as **deprecated**
 
 ## 0.3.4 (06.06.2016)
+
 * add exception class `Bitrix24EmptyResponseException`
 * in class `Bitrix24` add debug information for some error types
-* temporary remove calls to oauth.bitrix.info for methods `app.info` and `app.stat` see issue [Fix errors after change REST API to support self hosted version #43](https://github.com/mesilov/bitrix24-php-sdk/issues/43)   
+* temporary remove calls to oauth.bitrix.info for methods `app.info` and `app.stat` see
+  issue [Fix errors after change REST API to support self hosted version #43](https://github.com/mesilov/bitrix24-php-sdk/issues/43)
 
 ## 0.3.3 (28.05.2016)
-* fixed bug in class `Bitrix24` see issue [Fix errors after change REST API to support self hosted version #43](https://github.com/mesilov/bitrix24-php-sdk/issues/43)
+
+* fixed bug in class `Bitrix24` see
+  issue [Fix errors after change REST API to support self hosted version #43](https://github.com/mesilov/bitrix24-php-sdk/issues/43)
 
 ## 0.3.2 (07.05.2016)
-* fixed bug in class `Bitrix24\Im\Notify` see issue [ATTACH_ERROR for calls method im.notify for empty attach #42](https://github.com/mesilov/bitrix24-php-sdk/issues/42)
- 
+
+* fixed bug in class `Bitrix24\Im\Notify` see
+  issue [ATTACH_ERROR for calls method im.notify for empty attach #42](https://github.com/mesilov/bitrix24-php-sdk/issues/42)
+
 ## 0.3.1 (04.05.2016)
+
 * add `dev` branch in GitHub repo
 * fixed bug in class `Bitrix24\Im\Attach\Attach`, method `Attach::getAttachItems()` already return array
 
 ## 0.3.0 (04.05.2016)
+
 * add class `Bitrix24\Im\Attach\Item\Message` class implements work with string messages in attach item
-* add interface `Bitrix24\Presets\Im\iChatColor` with chat color presets  
+* add interface `Bitrix24\Presets\Im\iChatColor` with chat color presets
 * add phpUnit tests for items:
-  * `Bitrix24\Im\Attach\Item\Delimiter`
-  * `Bitrix24\Im\Attach\Item\File`
-  * `Bitrix24\Im\Attach\Item\Grid`
-  * `Bitrix24\Im\Attach\Item\Image`
-  * `Bitrix24\Im\Attach\Item\Link`
-  * `Bitrix24\Im\Attach\Item\Message`
-  * `Bitrix24\Im\Attach\Item\User`
-* fixed bug in class `Bitrix24\Im\Attach\Attach`  
+    * `Bitrix24\Im\Attach\Item\Delimiter`
+    * `Bitrix24\Im\Attach\Item\File`
+    * `Bitrix24\Im\Attach\Item\Grid`
+    * `Bitrix24\Im\Attach\Item\Image`
+    * `Bitrix24\Im\Attach\Item\Link`
+    * `Bitrix24\Im\Attach\Item\Message`
+    * `Bitrix24\Im\Attach\Item\User`
+* fixed bug in class `Bitrix24\Im\Attach\Attach`
 
 ## 0.2.1 (27.04.2016)
-* add exception class `Bitrix24PortalDeleted` and handle Bitrix24 portal deleted event. See issue [Add support for deleted portals #40](https://github.com/mesilov/bitrix24-php-sdk/issues/40)  
+
+* add exception class `Bitrix24PortalDeleted` and handle Bitrix24 portal deleted event. See
+  issue [Add support for deleted portals #40](https://github.com/mesilov/bitrix24-php-sdk/issues/40)
 
 ## 0.2.0 (24.06.2015)
+
 * add class `Deal`
 * add class `LiveFeedMessage`
 * add task fields presets
@@ -149,6 +191,7 @@
 * remove class `Bitrix24\Task\TaskItem`
 
 ## 0.1.4 (18.04.2015)
+
 * add presets for user fields data type structure
 * add method `Update` and predefined constants in class `Invoice`
 * add protected method `handleBitrix24APILevelErrors` in a base class
@@ -163,6 +206,7 @@
 * fixed bug in Fix method isAccessTokenExpire
 
 ## 0.1.3 (24.08.2014)
+
 * add const `TOTAL` and `RESULT` for class `Bitrix24\Presets\Main`
 * add class `Bitrix24\Presets\Users\Fields` for Bitrix24 users fields
 * add class `Bitrix24\Departments\Department`
@@ -178,6 +222,7 @@
 * fixed bug in __construct in abstract class `Bitrix24Entity`
 
 ## 0.1.2 (22.01.2014)
+
 * add security sign support in api-call
 * add class `User`
 * add method «admin» — Check is current user admin
@@ -186,9 +231,11 @@
 * add MIT-LICENSE
 
 ## 0.1.1 (9.10.2013)
+
 * add namespace support
 * add classes of Bitrix24 parts: tasks, sonet
 * add base class `Bitrix24Entity`
 
 ## 0.1.0 (26.10.2013)
+
 * Initial release

src/Services/CRM/Deal/Result/DealCategoryStageItemResult.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Deal\Result;
+
+use Bitrix24\SDK\Core\Result\AbstractItem;
+
+/**
+ * Class DealCategoryStageItemResult
+ *
+ * @property string $NAME
+ * @property int    $SORT
+ * @property string $STATUS_ID
+ */
+class DealCategoryStageItemResult extends AbstractItem
+{
+}

src/Services/CRM/Deal/Result/DealCategoryStagesResult.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Deal\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class DealCategoryStagesResult
+ *
+ * @property string $NAME
+ * @property int    $SORT
+ * @property string $STATUS_ID
+ */
+class DealCategoryStagesResult extends AbstractResult
+{
+    /**
+     * @return DealCategoryStageItemResult[]
+     * @throws BaseException
+     */
+    public function getDealCategoryStages(): array
+    {
+        $res = [];
+        foreach ($this->getCoreResponse()->getResponseData()->getResult()->getResultData() as $deal) {
+            $res[] = new DealCategoryStageItemResult($deal);
+        }
+
+        return $res;
+    }
+}

src/Services/CRM/Deal/Service/DealCategoryStage.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Services\CRM\Deal\Service;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Exceptions\TransportException;
+use Bitrix24\SDK\Services\AbstractService;
+use Bitrix24\SDK\Services\CRM\Deal\Result\DealCategoryStagesResult;
+
+/**
+ * Class DealCategoryStage
+ *
+ * @package Bitrix24\SDK\Services\CRM\Deal\Service
+ */
+class DealCategoryStage extends AbstractService
+{
+    /**
+     * @param int $categoryId
+     *
+     * @return DealCategoryStagesResult
+     * @throws BaseException
+     * @throws TransportException
+     */
+    public function list(int $categoryId): DealCategoryStagesResult
+    {
+        return new DealCategoryStagesResult(
+            $this->core->call(
+                'crm.dealcategory.stage.list',
+                [
+                    'id' => $categoryId,
+                ]
+            )
+        );
+    }
+}

src/Services/CRM/Deals/Service/DealCategoryStages.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Tests\Integration\Services\CRM\Deal\Service;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Exceptions\InvalidArgumentException;
+use Bitrix24\SDK\Core\Exceptions\TransportException;
+use Bitrix24\SDK\Services\CRM\Deal\Service\DealCategory;
+use Bitrix24\SDK\Services\CRM\Deal\Service\DealCategoryStage;
+use Bitrix24\SDK\Tests\Integration\Fabric;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Class DealCategoryStageTest
+ *
+ * @package Bitrix24\SDK\Tests\Integration\Services\CRM\Deal\Service
+ */
+class DealCategoryStageTest extends TestCase
+{
+    protected DealCategoryStage $dealCategoryStage;
+    protected DealCategory $dealCategory;
+
+    /**
+     * @covers DealCategoryStage::list()
+     * @throws BaseException
+     * @throws TransportException
+     */
+    public function testList(): void
+    {
+        $newCategoryId = (int)$this->dealCategory->add(['NAME' => 'php unit test'])->getId();
+        $res = $this->dealCategoryStage->list($newCategoryId);
+        $this::assertGreaterThan(1, count($res->getDealCategoryStages()));
+    }
+
+    /**
+     * @throws InvalidArgumentException
+     */
+    public function setUp(): void
+    {
+        $this->dealCategoryStage = Fabric::getServiceBuilder()->getCRMScope()->dealCategoryStage();
+        $this->dealCategory = Fabric::getServiceBuilder()->getCRMScope()->dealCategory();
+    }
+}