Merge pull request #31 from iDeaDe/1.2.3

Актуализация структур

CHANGELOG.md

@@ -1,6 +1,22 @@
 ApiShip SDK Change Log
 ==========================
 
+1.2.3 2023-03-03
+--------------------
+ - Актуализированы поля запросов и ответов:
+   - Калькулятор: 
+     - в запросе помечены устаревшими поля weight, width, height, length
+     - в ответ добавлены поля tariffProviderId, feesIncluded, insuranceFee, cashServiceFee
+   - Создание заказа:
+     - в запрос добавлен объект returnAddress
+     - в Item добавлены поля companyName, companyInn, companyPhone
+     - в Recipient добавлены lat и lng
+     - в Sender добавлены lat, lng, companyInn, addressString
+   - Статусы заказа:
+     - добавлены поля в orderInfo: providerKey и trackingUrl
+   - Список точек:
+     - добавлены regionType, cityType, community, communityGuid, communityType, worktime, fittingRoom, metro и extra
+
 1.2.2 2022-08-18
 --------------------
 - Фикс. Добавлено поле deliveryCostOriginal для тарифов до ПВЗ

src/Api/Calculator.php

@@ -32,11 +32,16 @@ public function calculate(CalculatorRequest $request, $headers = [])
                 if (isset($item->tariffs)) {
                     foreach ($item->tariffs as $itemTariff) {
                         $calculatorItemTariff = new Tariff();
-                        $calculatorItemTariff->setTariffId(isset($itemTariff->tariffId) ? $itemTariff->tariffId : null)
+                        $calculatorItemTariff
+                            ->setTariffProviderId($itemTariff->tariffProviderId ?? null)
+                            ->setTariffId(isset($itemTariff->tariffId) ? $itemTariff->tariffId : null)
                             ->setTariffName(isset($itemTariff->tariffName) ? $itemTariff->tariffName : null)
                             ->setFrom(isset($itemTariff->from) ? $itemTariff->from : null)
                             ->setDeliveryCost(isset($itemTariff->deliveryCost) ? $itemTariff->deliveryCost : null)
                             ->setDeliveryCostOriginal($itemTariff->deliveryCostOriginal ?? null)
+                            ->setFeesIncluded($itemTariff->feesIncluded ?? null)
+                            ->setInsuranceFee($itemTariff->insuranceFee ?? null)
+                            ->setCashServiceFee($itemTariff->cashServiceFee ?? null)
                             ->setDaysMin(isset($itemTariff->daysMin) ? $itemTariff->daysMin : null)
                             ->setDaysMax(isset($itemTariff->daysMax) ? $itemTariff->daysMax : null)
                             ->setPickupTypes(isset($itemTariff->pickupTypes) ? $itemTariff->pickupTypes : [])
@@ -56,11 +61,16 @@ public function calculate(CalculatorRequest $request, $headers = [])
                 if (isset($item->tariffs)) {
                     foreach ($item->tariffs as $itemTariff) {
                         $calculatorItemTariff = new Tariff();
-                        $calculatorItemTariff->setTariffId(isset($itemTariff->tariffId) ? $itemTariff->tariffId : null)
+                        $calculatorItemTariff
+                            ->setTariffProviderId($itemTariff->tariffProviderId ?? null)
+                            ->setTariffId(isset($itemTariff->tariffId) ? $itemTariff->tariffId : null)
                             ->setTariffName(isset($itemTariff->tariffName) ? $itemTariff->tariffName : null)
                             ->setFrom(isset($itemTariff->from) ? $itemTariff->from : null)
                             ->setDeliveryCost(isset($itemTariff->deliveryCost) ? $itemTariff->deliveryCost : null)
                             ->setDeliveryCostOriginal($itemTariff->deliveryCostOriginal ?? null)
+                            ->setFeesIncluded($itemTariff->feesIncluded ?? null)
+                            ->setInsuranceFee($itemTariff->insuranceFee ?? null)
+                            ->setCashServiceFee($itemTariff->cashServiceFee ?? null)
                             ->setDaysMin(isset($itemTariff->daysMin) ? $itemTariff->daysMin : null)
                             ->setDaysMax(isset($itemTariff->daysMax) ? $itemTariff->daysMax : null)
                             ->setPointIds(isset($itemTariff->pointIds) ? $itemTariff->pointIds : [])

src/Entity/Request/CalculatorRequest.php

@@ -151,6 +151,7 @@ public function setTo(To $to)
     }
 
     /**
+     * @deprecated
      * @return float
      * @throws RequiredParameterException
      */
@@ -167,6 +168,7 @@ public function getWeight()
     }
 
     /**
+     * @deprecated
      * @param float $weight
      *
      * @return CalculatorRequest
@@ -178,6 +180,7 @@ public function setWeight($weight)
     }
 
     /**
+     * @deprecated
      * @return int
      * @throws RequiredParameterException
      */
@@ -194,6 +197,7 @@ public function getWidth()
     }
 
     /**
+     * @deprecated
      * @param int $width
      *
      * @return CalculatorRequest
@@ -205,6 +209,7 @@ public function setWidth($width)
     }
 
     /**
+     * @deprecated
      * @return int
      * @throws RequiredParameterException
      */
@@ -221,6 +226,7 @@ public function getHeight()
     }
 
     /**
+     * @deprecated
      * @param int $height
      *
      * @return CalculatorRequest
@@ -232,6 +238,7 @@ public function setHeight($height)
     }
 
     /**
+     * @deprecated
      * @return int
      * @throws RequiredParameterException
      */
@@ -248,6 +255,7 @@ public function getLength()
     }
 
     /**
+     * @deprecated
      * @param int $length
      *
      * @return CalculatorRequest

src/Entity/Request/CreateOrderRequest.php

@@ -9,6 +9,7 @@
 use Apiship\Entity\Request\Part\Orders\Order;
 use Apiship\Entity\Request\Part\Orders\Place;
 use Apiship\Entity\Request\Part\Orders\Recipient;
+use Apiship\Entity\Request\Part\Orders\ReturnAddress;
 use Apiship\Entity\Request\Part\Orders\Sender;
 use Apiship\Exception\RequiredParameterException;
 
@@ -30,6 +31,10 @@ class CreateOrderRequest extends AbstractRequest
      * @var Recipient Информация о получателе
      */
     protected $recipient;
+    /**
+     * @var ReturnAddress
+     */
+    protected $returnAddress;
     /**
      * @var Item[] Массив с вложениями
      */
@@ -252,4 +257,15 @@ public function addExtraParam(ExtraParam $extraParam)
 
         return $this;
     }
-}
+
+    public function getReturnAddress(): ?ReturnAddress
+    {
+        return $this->returnAddress;
+    }
+
+    public function setReturnAddress(?ReturnAddress $returnAddress): self
+    {
+        $this->returnAddress = $returnAddress;
+        return $this;
+    }
+}

src/Entity/Request/Part/Orders/Item.php

@@ -51,11 +51,22 @@ class Item extends AbstractRequestPart
      * @var int Количество товара
      */
     protected $quantity;
-
     /**
      * @return string Код маркировки
      */
     protected $markCode;
+    /**
+     * @var string Наименование компании поставщика / продавца товара
+     */
+    protected $companyName;
+    /**
+     * @var string ИНН поставщика / продавца товара
+     */
+    protected $companyInn;
+    /**
+     * @var string Телефон поставщика / продавца товара
+     */
+    protected $companyPhone;
 
     /**
      * @return string
@@ -300,4 +311,37 @@ public function setMarkCode($markCode)
         $this->markCode = $markCode;
         return $this;
     }
-}
+
+    public function getCompanyName(): string
+    {
+        return $this->companyName;
+    }
+
+    public function setCompanyName(?string $companyName): self
+    {
+        $this->companyName = $companyName;
+        return $this;
+    }
+
+    public function getCompanyInn(): ?string
+    {
+        return $this->companyInn;
+    }
+
+    public function setCompanyInn(?string $companyInn): self
+    {
+        $this->companyInn = $companyInn;
+        return $this;
+    }
+
+    public function getCompanyPhone(): ?string
+    {
+        return $this->companyPhone;
+    }
+
+    public function setCompanyPhone(?string $companyPhone): self
+    {
+        $this->companyPhone = $companyPhone;
+        return $this;
+    }
+}

src/Entity/Request/Part/Orders/Recipient.php

@@ -47,6 +47,14 @@ class Recipient extends AbstractRequestPart
      * @var string Квартира/офис
      */
     protected $office;
+    /**
+     * @var float Широта
+     */
+    protected $lat;
+    /**
+     * @var float Долгота
+     */
+    protected $lng;
     /**
      * @var string ИНН компании (если юр.лицо)
      */
@@ -457,4 +465,26 @@ public function setAddressString($addressString)
 
         return $this;
     }
+
+    public function getLat(): ?float
+    {
+        return $this->lat;
+    }
+
+    public function setLat(?float $lat): self
+    {
+        $this->lat = $lat;
+        return $this;
+    }
+
+    public function getLng(): ?float
+    {
+        return $this->lng;
+    }
+
+    public function setLng(?float $lng): self
+    {
+        $this->lng = $lng;
+        return $this;
+    }
 }