Merge branch 'dev' into feature/265-add-disk

Author: vadimsallee

CHANGELOG.md

@@ -48,6 +48,38 @@
     - `getVersions` returns a list of file versions
     - `restoreFromVersion` restores the file from a specific version
     - `getExternalLink` returns a public link to the file
+- Added service `Services\Sale\Shipment\Service\Shipment` with support methods,
+  see [sale.shipment.* methods](https://github.com/bitrix24/b24phpsdk/issues/250):
+    - `add` adds a shipment
+    - `update` updates the fields of a shipment
+    - `get` returns a shipment by its identifier
+    - `list` returns a list of shipments
+    - `delete` deletes a shipment
+    - `getFields` returns the fields and settings for shipments
+- Added service `Services\Sale\ShipmentProperty\Service\ShipmentProperty` with support methods,
+  see [sale.shipmentproperty.* methods](https://github.com/bitrix24/b24phpsdk/issues/250):
+    - `add` adds a shipment property
+    - `update` updates the fields of a shipment property
+    - `get` returns a shipment property by its identifier
+    - `list` returns a list of shipment properties
+    - `delete` deletes a shipment property
+    - `getFieldsByType` returns the fields and settings for shipment properties by type
+- Added service `Services\Sale\ShipmentPropertyValue\Service\ShipmentPropertyValue` with support methods,
+  see [sale.shipmentpropertyvalue.* methods](https://github.com/bitrix24/b24phpsdk/issues/250):
+    - `modify` updates shipment property values for a shipment
+    - `get` returns a shipment property value by its identifier
+    - `list` returns a list of shipment property values
+    - `delete` deletes a shipment property value
+    - `getFields` returns the fields and settings for shipment property values
+
+- Added service `Services\Sale\ShipmentItem\Service\ShipmentItem` with support methods,
+  see [sale.shipmentitem.* methods](https://github.com/bitrix24/b24phpsdk/issues/250):
+    - `add` adds a new shipment item
+    - `update` updates the fields of a shipment item
+    - `get` returns a shipment item by its identifier
+    - `list` returns a list of shipment items
+    - `delete` deletes a shipment item
+    - `getFields` returns the fields and settings for shipment items
 - Added service `Services\Sale\Payment\Service\Payment` with support methods,
   see [sale.payment.* methods](https://github.com/bitrix24/b24phpsdk/issues/248):
     - `add` adds a payment
@@ -56,6 +88,28 @@
     - `list` returns a list of payments
     - `delete` deletes a payment
     - `getFields` returns the fields and settings for payments
+- Added service `Services\Sale\PaymentItemBasket\Service\PaymentItemBasket` with support methods,
+  see [sale.paymentitembasket.* methods](https://github.com/bitrix24/b24phpsdk/issues/253):
+    - `add` adds a binding of a basket item to a payment
+    - `update` updates the binding of a basket item to a payment
+    - `get` returns the values of all fields for the basket item binding to payment
+    - `list` returns a list of bindings of basket items to payments
+    - `delete` deletes the binding of a basket item to a payment
+    - `getFields` returns the available fields for payment item basket bindings
+- Added service `Services\Sale\PaymentItemShipment\Service\PaymentItemShipment` with support methods,
+  see [sale.paymentitemshipment.* methods](https://github.com/bitrix24/b24phpsdk/issues/253):
+    - `add` adds a binding of a payment to a shipment
+    - `update` updates the binding of a payment to a shipment
+    - `get` returns the values of all fields for the payment binding to shipment
+    - `list` returns a list of bindings of payments to shipments
+    - `delete` deletes the binding of a payment to a shipment
+    - `getFields` returns the available fields for payment item shipment bindings
+- Added service `Services\Sale\PropertyRelation\Service\PropertyRelation` with support methods,
+  see [sale.propertyRelation.* methods](https://github.com/bitrix24/b24phpsdk/issues/253):
+    - `add` adds a property binding
+    - `list` retrieves a list of property bindings
+    - `deleteByFilter` removes the property relation
+    - `getFields` returns the available fields for property binding
 
 ## 1.6.0 – 2025.09.01
 

Makefile

@@ -51,6 +51,9 @@ help:
 	@echo ""
 	@echo "test-unit                 - run unit tests"
 	@echo "test-integration-sale-basket-property - run BasketProperty integration tests"
+	@echo "test-integration-sale-payment-item-basket - run PaymentItemBasket integration tests"
+	@echo "test-integration-sale-payment-item-shipment - run PaymentItemShipment integration tests"
+	@echo "test-integration-sale-property-relation - run PropertyRelation integration tests"
 
 
 .PHONY: docker-init
@@ -216,6 +219,22 @@ test-integration-sale-status:
 test-integration-sale-status-lang:
 	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_status_lang
 
+.PHONY: test-integration-scope-sale-shipment
+test-integration-scope-sale-shipment:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_shipment
+
+.PHONY: test-integration-scope-sale-shipment-property
+test-integration-scope-sale-shipment-property:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_shipment_property
+
+.PHONY: test-integration-scope-sale-shipment-property-value
+test-integration-scope-sale-shipment-property-value:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_shipment_property_value
+
+.PHONY: test-integration-scope-sale-shipment-item
+test-integration-scope-sale-shipment-item:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_shipment_item
+
 .PHONY: test-integration-sale-basket-property
 test-integration-sale-basket-property:
 	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_basket_property
@@ -227,6 +246,18 @@ test-integration-sale-basket:
 .PHONY: test-integration-sale-order
 test-integration-sale-order:
 	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_order
+
+.PHONY: test-integration-sale-payment-item-basket
+test-integration-sale-payment-item-basket:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_payment_item_basket
+
+.PHONY: test-integration-sale-payment-item-shipment
+test-integration-sale-payment-item-shipment:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_payment_item_shipment
+
+.PHONY: test-integration-sale-property-relation
+test-integration-sale-property-relation:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_property_relation
 
 .PHONY: test-integration-scope-crm
 test-integration-scope-crm:
@@ -320,6 +351,10 @@ integration_tests_sale:
 integration_tests_sale_payment:
 	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_payment
 
+.PHONY: integration_tests_sale_payment_item_basket
+integration_tests_sale_payment_item_basket:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_sale_payment_item_basket
+
 # work dev environment
 .PHONY: php-dev-server-up
 php-dev-server-up:

phpunit.xml.dist

@@ -145,9 +145,30 @@
         <testsuite name="integration_tests_sale_payment">
             <directory>./tests/Integration/Services/Sale/Payment/</directory>
         </testsuite>
+        <testsuite name="integration_tests_sale_payment_item_basket">
+            <directory>./tests/Integration/Services/Sale/PaymentItemBasket/</directory>
+        </testsuite>
+        <testsuite name="integration_tests_sale_payment_item_shipment">
+            <directory>./tests/Integration/Services/Sale/PaymentItemShipment/</directory>
+        </testsuite>
+        <testsuite name="integration_tests_sale_property_relation">
+            <directory>./tests/Integration/Services/Sale/PropertyRelation/</directory>
+        </testsuite>
         <testsuite name="integration_tests_sale_order">
             <directory>./tests/Integration/Services/Sale/Order/</directory>
         </testsuite>
+        <testsuite name="integration_tests_sale_shipment">
+            <directory>./tests/Integration/Services/Sale/Shipment/</directory>
+        </testsuite>
+        <testsuite name="integration_tests_sale_shipment_property">
+            <directory>./tests/Integration/Services/Sale/ShipmentProperty/</directory>
+        </testsuite>
+        <testsuite name="integration_tests_sale_shipment_property_value">
+            <directory>./tests/Integration/Services/Sale/ShipmentPropertyValue/</directory>
+        </testsuite>
+        <testsuite name="integration_tests_sale_shipment_item">
+            <directory>./tests/Integration/Services/Sale/ShipmentItem/</directory>
+        </testsuite>
     </testsuites>
     <source>
         <include>

src/Services/Sale/PaymentItemBasket/Result/PaymentItemBasketAddedResult.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Sally Fancen <[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\Sale\PaymentItemBasket\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AddedItemResult;
+
+/**
+ * Class PaymentItemBasketAddedResult
+ * Represents the result of an add payment item basket binding operation.
+ */
+class PaymentItemBasketAddedResult extends AddedItemResult
+{
+    /**
+     * @throws BaseException
+     */
+    public function getId(): int
+    {
+        $result = $this->getCoreResponse()->getResponseData()->getResult();
+        return isset($result['paymentItemBasket']['id']) ? (int)$result['paymentItemBasket']['id'] : 0;
+    }
+}

src/Services/Sale/PaymentItemBasket/Result/PaymentItemBasketFieldsResult.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Sally Fancen <[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\Sale\PaymentItemBasket\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\FieldsResult;
+
+/**
+ * Class PaymentItemBasketFieldsResult
+ * Represents the result of a payment item basket binding fields operation.
+ */
+class PaymentItemBasketFieldsResult extends FieldsResult
+{
+    /**
+     * @throws BaseException
+     */
+    public function getFieldsDescription(): array
+    {
+        $result = $this->getCoreResponse()->getResponseData()->getResult();
+        return $result['paymentItemBasket'] ?? [];
+    }
+}

src/Services/Sale/PaymentItemBasket/Result/PaymentItemBasketItemResult.php

@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Sally Fancen <[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\Sale\PaymentItemBasket\Result;
+
+use Bitrix24\SDK\Core\Result\AbstractItem;
+use Carbon\CarbonImmutable;
+
+/**
+ * Class PaymentItemBasketItemResult
+ * Represents a single payment item basket binding returned by Bitrix24 REST API.
+ *
+ * Fields and their types are taken from Bitrix24 API (sale.paymentitembasket.getfields).
+ *
+ * @property-read int|null $id Binding identifier
+ * @property-read int|null $paymentId Payment identifier
+ * @property-read int|null $basketId Basket item identifier
+ * @property-read string|null $quantity Quantity of the product
+ * @property-read string|null $xmlId External record identifier
+ * @property-read CarbonImmutable|null $dateInsert Date when the binding was created
+ */
+class PaymentItemBasketItemResult extends AbstractItem
+{
+    public function getId(): ?int
+    {
+        return isset($this->data['id']) ? (int)$this->data['id'] : null;
+    }
+
+    public function getPaymentId(): ?int
+    {
+        return isset($this->data['paymentId']) ? (int)$this->data['paymentId'] : null;
+    }
+
+    public function getBasketId(): ?int
+    {
+        return isset($this->data['basketId']) ? (int)$this->data['basketId'] : null;
+    }
+
+    public function getQuantity(): ?float
+    {
+        return isset($this->data['quantity']) ? (float)$this->data['quantity'] : null;
+    }
+
+    public function getXmlId(): ?string
+    {
+        return isset($this->data['xmlId']) ? (string)$this->data['xmlId'] : null;
+    }
+
+    public function getDateInsert(): ?CarbonImmutable
+    {
+        return isset($this->data['dateInsert']) ? CarbonImmutable::parse($this->data['dateInsert']) : null;
+    }
+}

src/Services/Sale/PaymentItemBasket/Result/PaymentItemBasketResult.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Sally Fancen <[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\Sale\PaymentItemBasket\Result;
+
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class PaymentItemBasketResult
+ * Represents the result of a single payment item basket binding operation.
+ */
+class PaymentItemBasketResult extends AbstractResult
+{
+    /**
+     * Returns the payment item basket binding as PaymentItemBasketItemResult
+     */
+    public function paymentItemBasket(): PaymentItemBasketItemResult
+    {
+        $result = $this->getCoreResponse()->getResponseData()->getResult();
+        return new PaymentItemBasketItemResult($result['paymentItemBasket'] ?? []);
+    }
+}

src/Services/Sale/PaymentItemBasket/Result/PaymentItemBasketUpdatedResult.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Sally Fancen <[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\Sale\PaymentItemBasket\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\UpdatedItemResult;
+
+/**
+ * Class PaymentItemBasketUpdatedResult
+ * Represents the result of an update payment item basket binding operation.
+ */
+class PaymentItemBasketUpdatedResult extends UpdatedItemResult
+{
+    /**
+     * @throws BaseException
+     */
+    public function isSuccess(): bool
+    {
+        $result = $this->getCoreResponse()->getResponseData()->getResult();
+        return isset($result['paymentItemBasket']) && !empty($result['paymentItemBasket']);
+    }
+}

src/Services/Sale/PaymentItemBasket/Result/PaymentItemBasketsResult.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Sally Fancen <[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\Sale\PaymentItemBasket\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class PaymentItemBasketsResult
+ * Represents the result of a list payment item basket bindings operation.
+ */
+class PaymentItemBasketsResult extends AbstractResult
+{
+    /**
+     * Returns an array of payment item basket binding items
+     *
+     * @return PaymentItemBasketItemResult[] array of payment item basket binding item results
+     * @throws BaseException
+     */
+    public function getPaymentItemBaskets(): array
+    {
+        $result = $this->getCoreResponse()->getResponseData()->getResult();
+        $paymentItemBaskets = $result['paymentItemsBasket'] ?? [];
+        return array_map(fn ($item): PaymentItemBasketItemResult => new PaymentItemBasketItemResult($item), $paymentItemBaskets);
+    }
+}