OrderedPackage.php

<?php

namespace Inspirum\Balikobot\Model\Values;

class OrderedPackage
{
    /**
     * Package ID
     *
     * @var string
     */
    private $packageId;

    /**
     * Package batch ID (EID)
     *
     * @var string
     */
    private $batchId;

    /**
     * Shipper
     *
     * @var string
     */
    private $shipper;

    /**
     * Carrier ID (for package tracking)
     *
     * @var string
     */
    private $carrierId;

    /**
     * Track URL
     *
     * @var string|null
     */
    private $trackUrl;

    /**
     * Label URL
     *
     * @var string|null
     */
    private $labelUrl;

    /**
     * Carrier ID Swap
     *
     * @var string|null
     */
    private $carrierIdSwap;

    /**
     * Pieces
     *
     * @var array<string>
     */
    private $pieces;

    /**
     * Final carrier ID
     *
     * @var string|null
     */
    private $finalCarrierId;

    /**
     * Final track URL
     *
     * @var string|null
     */
    private $finalTrackUrl;

    /**
     * OrderedPackage constructor
     *
     * @param string        $packageId
     * @param string        $shipper
     * @param string        $batchId
     * @param string        $carrierId
     * @param string|null   $trackUrl
     * @param string|null   $labelUrl
     * @param string|null   $carrierIdSwap
     * @param array<string> $pieces
     * @param string|null   $finalCarrierId
     * @param string|null   $finalTrackUrl
     */
    public function __construct(
        string $packageId,
        string $shipper,
        string $batchId,
        string $carrierId,
        string $trackUrl = null,
        string $labelUrl = null,
        string $carrierIdSwap = null,
        array $pieces = [],
        string $finalCarrierId = null,
        string $finalTrackUrl = null
    ) {
        $this->packageId      = $packageId;
        $this->shipper        = $shipper;
        $this->batchId        = $batchId;
        $this->carrierId      = $carrierId;
        $this->trackUrl       = $trackUrl;
        $this->labelUrl       = $labelUrl;
        $this->carrierIdSwap  = $carrierIdSwap;
        $this->pieces         = $pieces;
        $this->finalCarrierId = $finalCarrierId;
        $this->finalTrackUrl  = $finalTrackUrl;
    }

    /**
     * @return string
     */
    public function getPackageId(): string
    {
        return $this->packageId;
    }

    /**
     * @return string
     */
    public function getBatchId(): string
    {
        return $this->batchId;
    }

    /**
     * @return string
     */
    public function getCarrierId(): string
    {
        return $this->carrierId;
    }

    /**
     * @return string|null
     */
    public function getTrackUrl(): ?string
    {
        return $this->trackUrl;
    }

    /**
     * @return string|null
     */
    public function getLabelUrl(): ?string
    {
        return $this->labelUrl;
    }

    /**
     * @return string|null
     */
    public function getCarrierIdSwap(): ?string
    {
        return $this->carrierIdSwap;
    }

    /**
     * @return array<string>
     */
    public function getPieces(): array
    {
        return $this->pieces;
    }

    /**
     * @return string
     */
    public function getShipper(): string
    {
        return $this->shipper;
    }

    /**
     * @return string|null
     */
    public function getFinalCarrierId(): ?string
    {
        return $this->finalCarrierId;
    }

    /**
     * @return string|null
     */
    public function getFinalTrackUrl(): ?string
    {
        return $this->finalTrackUrl;
    }

    /**
     * @param string              $shipper
     * @param array<string,mixed> $data
     *
     * @return \Inspirum\Balikobot\Model\Values\OrderedPackage
     */
    public static function newInstanceFromData(string $shipper, array $data): self
    {
        return new self(
            $data['package_id'],
            $shipper,
            $data['eid'],
            $data['carrier_id'] ?? '',
            $data['track_url'] ?? null,
            $data['label_url'] ?? null,
            $data['carrier_id_swap'] ?? null,
            $data['pieces'] ?? [],
            $data['carrier_id_final'] ?? null,
            $data['track_url_final'] ?? null
        );
    }
}