Merge pull request #209 from bitrix24/dev

Build 1.5.0

Author: mesilov

.php-cs-fixer.php

@@ -7,11 +7,16 @@
 $finder = Finder::create()
     ->in(__DIR__ . '/src/Infrastructure/Console/Commands/')
     ->in(__DIR__ . '/src/Services/CRM/Address/')
-    ->in(__DIR__ . '/src/Services/CRM/Item/Service/')
+    ->in(__DIR__ . '/src/Services/CRM/Item/')
     ->in(__DIR__ . '/src/Services/CRM/Contact/')
     ->in(__DIR__ . '/src/Services/CRM/Quote/')
     ->in(__DIR__ . '/src/Services/CRM/Lead/')
     ->in(__DIR__ . '/src/Services/CRM/Currency/')
+    ->in(__DIR__ . '/src/Services/CRM/Requisites/')
+    ->in(__DIR__ . '/src/Services/CRM/Status/')
+    ->in(__DIR__ . '/src/Services/CRM/Timeline/')
+    ->in(__DIR__ . '/src/Services/Entity/Section/')
+    ->in(__DIR__ . '/src/Services/Department/')
     ->name('*.php')
     ->exclude(['vendor', 'storage', 'docker', 'docs']) // Exclude directories
     ->ignoreDotFiles(true)

CHANGELOG.md

@@ -1,12 +1,124 @@
 # b24-php-sdk change log
 
+## UPCOMING 1.6.0 – 2025.09.01
+
+## 1.5.0 – 2025.08.01
+
+### Added
+
+- Added service `Services\Entity\Section\Service\Section` with support methods,
+  see [crm.entity.section.* methods](https://github.com/bitrix24/b24phpsdk/issues/200):
+    - `get` retrieve a list of storage sections, with batch calls support
+    - `add` add a storage section, with batch calls support
+    - `update` update a storage section, with batch calls support
+    - `delete` delete a storage section, with batch calls support
+- Added service `Services\Entity\Item\Property\Service\Property` with support methods:
+    - `get` retrieve a list of additional properties of storage elements, with batch calls support
+    - `add` add an additional property to storage elements, with batch calls support
+    - `update` update an additional property of storage elements, with batch calls support
+    - `delete` delete an additional property of storage elements, with batch calls support
+- Added service `Services\Department\Service\Department` with support methods,
+  see [department.* methods](https://github.com/bitrix24/b24phpsdk/issues/204):
+    - `fields` gets the department fields reference
+    - `get` retrieves a list of departments, with batch calls support
+    - `add` creates a department, with batch calls support
+    - `delete` deletes a department, with batch calls support
+    - `update` modifies a department, with batch calls support
+    - `countByFilter` count departments by filter
+- Added service `CRM\Requisites\Service\RequisiteUserfield` with support methods,
+  see [add crm.requisite.userfield.* methods](https://github.com/bitrix24/b24phpsdk/issues/188):
+  - `add` add userfield to requisite
+  - `get` get userfield to requisite
+  - `list` list userfields
+  - `delete` delete userfield
+  - `update` update userfield
+- Added service `CRM\Requisites\Service\RequisiteBankdetail` with support methods:
+  - `add` add bank detail to requisite
+  - `get` get bank detail to requisite
+  - `fields` get fields for bank details
+  - `list` list bank details
+  - `delete` delete bank detail
+  - `update` update bank detail
+  - `countByFilter` count bank details by filter
+- Added service `CRM\Requisites\Service\RequisiteLink` with support methods:
+  - `register` registers the link between requisites and an object
+  - `unregister` removes the link between requisites and an object
+  - `fields` get a formal description of the fields of the requisites link
+  - `get` returns the link between requisites and an object
+  - `list` returns a list of links between requisites based on a filter
+  - `countByFilter` count links by filter
+- Added service `CRM\Requisites\Service\RequisitePresetField` with support methods:
+  - `add` adds a customizable field to the requisites template
+  - `get` returns the description of the custom field in the requisites template by identifier
+  - `fields` returns the description of the custom field in the requisites template by identifier
+  - `list` returns a list of all custom fields for a specific requisites template
+  - `delete` deletes a customizable field from the requisites template
+  - `update` modifies a custom field in the requisites template
+  - `availabletoadd` returns fields available for addition to the specified requisites template
+- Added service `Services\CRM\Status\Service\Status` with support methods,
+  see [crm.status.* methods](https://github.com/bitrix24/b24phpsdk/issues/194):
+  - `fields` returns descriptions of reference book fields
+  - `get` returns an element of the reference book by its identifier
+  - `list` returns a list of elements of the reference book by filter, with batch calls support
+  - `add` creates a new element in the specified reference book, with batch calls support
+  - `delete` deletes an element from the reference book, with batch calls support
+  - `update` updates an existing element of the reference book, with batch calls support
+  - `countByFilter` counts elements of the reference book by filter
+- Added service `Services\CRM\Status\Service\StatusEntity` with support methods,
+  - `items` returns elements of the reference book by its symbolic identifier
+  - `types` returns descriptions of reference book types
+- Added service `Services\CRM\Timeline\Service\Comment` with support methods,
+  see [crm.timeline.comment.* methods](https://github.com/bitrix24/b24phpsdk/issues/196):
+  - `fields` retrieves a list of timeline comment fields
+  - `get` retrieves information about a comment
+  - `list` retrieves a list of all comments for a CRM entity, with batch calls support
+  - `add` adds a new comment to the timeline, with batch calls support
+  - `delete` deletes a comment, with batch calls support
+  - `update` updates a comment, with batch calls support
+  - `countByFilter` count comments by filter
+- Added support for events:
+  - `OnCrmTimelineCommentAdd`
+  - `OnCrmTimelineCommentDelete`
+  - `OnCrmTimelineCommentUpdate`
+- Added service `Services\CRM\Timeline\Service\Bindings` with support methods:
+  - `fields` retrieves the fields of the link between CRM entities and the timeline record
+  - `list` retrieves a list of links for a timeline record, with batch calls support
+  - `bind` adds a link between a timeline record and a CRM entity, with batch calls support
+  - `unbind` removes a link between a timeline record and a CRM entity, with batch calls support
+  - `countByFilter` count links between a timeline record and CRM entities by filter
+- Added service `Services\CRM\Item\Productrow\Service\Productrow` with support methods,
+  see [crm.item.productrow.* methods](https://github.com/bitrix24/b24phpsdk/issues/198):
+  - `fields` retrieves a list of product item fields
+  - `set` associates a product item with a CRM object
+  - `get` retrieves information about a product item by id
+  - `list` retrieves a list of product items, with batch calls support
+  - `add` adds a product item, with batch calls support
+  - `delete` deletes a product item, with batch calls support
+  - `update` updates a product item
+  - `getAvailableForPayment` retrieves a list of unpaid products
+  - `countByFilter` counts product items by filter
+  
+### Fixed
+- Fixed typehints in Contact batch for method `add`, [see details](https://github.com/bitrix24/b24phpsdk/issues/202)
+
+### Changed
+- Fixed constructor arguments in tests ApplicationInstallations [see details](https://github.com/bitrix24/b24phpsdk/issues/191)
+- Bump giggsey/libphonenumber-for-php version to ^8|^9
+
+### Statistics
+```
+Bitrix24 API-methods count: 1166
+Supported in bitrix24-php-sdk methods count: 362
+Coverage percentage: 31.05%
+```
+
 ## 1.4.0 – 2025.07.01
 
 ### Added
 
 - Added service `Services\CRM\Lead\Service\LeadContact` with support methods,
   see [crm.lead.contact.* methods](https://github.com/bitrix24/b24phpsdk/issues/170):
-    - `fields` get fiels for lead contact connection
+    - `fields` get fields for lead contact connection
     - `setItems` set contacts related with lead
     - `get` get contacts related to lead
     - `deleteItems` delete all relations for lead

Makefile

@@ -227,9 +227,9 @@ integration_tests_lead_details:
 integration_tests_scope_automation:
 	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_scope_automation
 
-.PHONY: integration_tests_item_details
-integration_tests_item_details:
-	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_item_details
+.PHONY: integration_tests_crm_item
+integration_tests_crm_item:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_item
 
 .PHONY: integration_tests_lead_productrows
 integration_tests_lead_productrows:
@@ -238,6 +238,30 @@ integration_tests_lead_productrows:
 .PHONY: integration_tests_crm_quote
 integration_tests_crm_quote:
 	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_quote
+	
+.PHONY: integration_tests_crm_requisite
+integration_tests_crm_requisite:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_requisite
+	
+.PHONY: integration_tests_crm_preset_field
+integration_tests_crm_preset_field:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_preset_field
+	
+.PHONY: integration_tests_crm_requisite_userfield
+integration_tests_crm_requisite_userfield:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_requisite_userfield
+
+.PHONY: integration_tests_crm_status
+integration_tests_crm_status:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_status
+
+.PHONY: integration_tests_crm_timeline
+integration_tests_crm_timeline:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_timeline
+
+.PHONY: integration_tests_department
+integration_tests_department:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_department
 
 # work dev environment
 .PHONY: php-dev-server-up

README.md

@@ -28,7 +28,7 @@ If You work on Windows:
 - please use [WSL - Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/) 
 - if your filesystem is NTFS, You can disable flag `git config --global core.protectNTFS false` for checkout folders started with dot.
 
-Or add `"bitrix24/b24phpsdk": "1.4.*"` to `composer.json` of your application.
+Or add `"bitrix24/b24phpsdk": "1.5.*"` to `composer.json` of your application.
 
 ## B24PhpSdk ✨FEATURES✨
 

composer.json

@@ -31,7 +31,7 @@
     "ext-intl": "*",
     "psr/log": "^2 || ^3",
     "fig/http-message-util": "^1",
-    "giggsey/libphonenumber-for-php": "^8",
+    "giggsey/libphonenumber-for-php": "^8 || ^9",
     "darsyn/ip": "^4 || ^5",
     "nesbot/carbon": "^3",
     "moneyphp/money": "^3 || ^4",

phpstan.neon.dist

@@ -14,7 +14,7 @@ parameters:
     - tests/Integration/Services/CRM/Address
     - tests/Integration/Services/CRM/Deal/Service/DealRecurringTest.php
     - tests/Integration/Services/CRM/Lead/Service/LeadContactTest.php
-    - tests/Integration/Services/CRM/Item/Service/ItemDetailsConfigurationTest.php
+    - tests/Integration/Services/CRM/Item
     - tests/Integration/Services/CRM/Deal/Service/DealDetailsConfigurationTest.php
     - tests/Integration/Services/CRM/Lead/Service/LeadDetailsConfigurationTest.php
     - tests/Integration/Services/CRM/Contact/Service/ContactDetailsConfigurationTest.php
@@ -26,6 +26,13 @@ parameters:
     - tests/Integration/Services/CRM/Quote/Service/QuoteProductRowsTest.php
     - tests/Integration/Services/CRM/Lead/Service/LeadUserfieldTest.php
     - tests/Integration/Services/CRM/Currency
+    - tests/Integration/Services/CRM/Requisites
+  excludePaths:
+    - tests/Integration/Services/CRM/Requisites/Service/RequisiteUserfieldUseCaseTest.php
+    - tests/Integration/Services/CRM/Status
+    - tests/Integration/Services/CRM/Timeline
+    - tests/Integration/Services/Entity/Section
+    - tests/Integration/Services/Department
   bootstrapFiles:
     - tests/bootstrap.php
   parallel:

phpunit.xml.dist

@@ -73,8 +73,8 @@
         <testsuite name="integration_tests_lead_contacts">
             <file>./tests/Integration/Services/CRM/Lead/Service/LeadContactTest.php</file>
         </testsuite>
-        <testsuite name="integration_tests_item_details">
-            <file>./tests/Integration/Services/CRM/Item/Service/ItemDetailsConfigurationTest.php</file>
+        <testsuite name="integration_tests_crm_item">
+            <directory>./tests/Integration/Services/CRM/Item/Productrow/</directory>
         </testsuite>
         <testsuite name="integration_tests_scope_automation">
             <directory>./tests/Integration/Services/CRM/Automation/</directory>
@@ -85,6 +85,24 @@
         <testsuite name="integration_tests_crm_quote">
             <directory>./tests/Integration/Services/CRM/Quote/</directory>
         </testsuite>
+        <testsuite name="integration_tests_crm_requisite">
+            <file>./tests/Integration/Services/CRM/Requisites/Service/RequisiteLinkTest.php</file>
+        </testsuite>
+        <testsuite name="integration_tests_crm_preset_field">
+            <file>./tests/Integration/Services/CRM/Requisites/Service/RequisitePresetFieldTest.php</file>
+        </testsuite>
+        <testsuite name="integration_tests_crm_requisite_userfield">
+            <file>./tests/Integration/Services/CRM/Requisites/Service/RequisiteUserfieldTest.php</file>
+        </testsuite>
+        <testsuite name="integration_tests_crm_status">
+            <directory>./tests/Integration/Services/CRM/Status/</directory>
+        </testsuite>
+        <testsuite name="integration_tests_crm_timeline">
+            <directory>./tests/Integration/Services/CRM/Timeline/</directory>
+        </testsuite>
+        <testsuite name="integration_tests_department">
+            <directory>./tests/Integration/Services/Department/</directory>
+        </testsuite>
     </testsuites>
     <source>
         <include>

rector.php

@@ -38,8 +38,8 @@
         __DIR__ . '/tests/Integration/Services/Placement',
         __DIR__ . '/src/Services/CRM/Deal',
         __DIR__ . '/tests/Integration/Services/CRM/Deal/Service',
-        __DIR__ . '/src/Services/CRM/Item/Service',
-        __DIR__ . '/tests/Integration/Services/CRM/Item/Service',
+        __DIR__ . '/src/Services/CRM/Item',
+        __DIR__ . '/tests/Integration/Services/CRM/Item',
         __DIR__ . '/src/Services/CRM/Deal/Service/DealDetailsConfiguration.php',
         __DIR__ . '/tests/Integration/Services/CRM/Deal/Service/DealDetailsConfigurationTest.php',
         __DIR__ . '/src/Services/CRM/Contact/Service/ContactDetailsConfiguration.php',
@@ -50,6 +50,14 @@
         __DIR__ . '/tests/Integration/Services/CRM/Quote/Service',
         __DIR__ . '/src/Services/CRM/Currency',
         __DIR__ . '/tests/Integration/Services/CRM/Currency',
+        __DIR__ . '/src/Services/CRM/Requisites',
+        __DIR__ . '/tests/Integration/Services/CRM/Requisites',
+        __DIR__ . '/src/Services/CRM/Timeline',
+        __DIR__ . '/tests/Integration/Services/CRM/Timeline',
+        __DIR__ . '/src/Services/Entity/Section',
+        __DIR__ . '/tests/Integration/Services/Entity/Section',
+        __DIR__ . '/src/Services/Department',
+        __DIR__ . '/tests/Integration/Services/Department',
         __DIR__ . '/tests/Unit/',
     ])
     ->withCache(cacheDirectory: __DIR__ . '.cache/rector')

src/Core/ApiClient.php

@@ -38,7 +38,7 @@ class ApiClient implements ApiClientInterface
     /**
      * @const string
      */
-    protected const SDK_VERSION = '1.4.0';
+    protected const SDK_VERSION = '1.5.0';
 
     protected const SDK_USER_AGENT = 'b24-php-sdk-vendor';
 

src/Core/Batch.php

@@ -34,6 +34,16 @@
  */
 class Batch implements BatchOperationsInterface
 {
+    protected const ENTITY_METHODS = [
+        'entity.item.delete',
+        'entity.section.delete',
+        'entity.item.get',
+        'entity.section.get',
+        'entity.item.update',
+        'entity.section.update',
+        'entity.item.property.update',
+    ];
+    
     protected const MAX_BATCH_PACKET_SIZE = 50;
 
     protected const MAX_ELEMENTS_IN_PAGE = 50;
@@ -144,7 +154,7 @@ public function deleteEntityItems(
 
                 $parameters = $useFieldsInsteadOfId ? ['fields' => $itemId] : ['ID' => $itemId];
                 // TODO: delete after migration to RestAPI v2
-                if ($apiMethod === 'entity.item.delete') {
+                if (in_array($apiMethod, self::ENTITY_METHODS)) {
                     $parameters = array_merge($parameters, $additionalParameters);
                 }
 
@@ -218,7 +228,7 @@ public function updateEntityItems(string $apiMethod, array $entityItems): Genera
                     );
                 }
 
-                if ($apiMethod !== 'entity.item.update') {
+                if (!in_array($apiMethod, self::ENTITY_METHODS)) {
                     if (!array_key_exists('fields', $entityItem)) {
                         throw new InvalidArgumentException(
                             sprintf('array key «fields» not found in entity item with id %s', $entityItemId)
@@ -482,7 +492,7 @@ public function getTraversableList(
         // todo wait new api version
         if ($apiMethod !== 'user.get') {
             $defaultOrderKey = 'order';
-            $orderKey = $apiMethod === 'entity.item.get' ? 'SORT' : $defaultOrderKey;
+            $orderKey = in_array($apiMethod, self::ENTITY_METHODS) ? 'SORT' : $defaultOrderKey;
 
             $params = [
                 $orderKey => $this->getReverseOrder($order),