<?php

declare(strict_types=1);

namespace Mirakl\MMP\Common\Domain\Shipment;

use Mirakl\Core\Domain\MiraklObject;
use Mirakl\MMP\Common\Domain\Collection\Shipment\ShipmentAdditionalInformationCollection;
use Mirakl\MMP\Common\Domain\Collection\Shipment\ShipmentLineCollection;

/**
 * @method string                                  getId()
 * @method $this                                   setId(string $id)
 * @method string                                  getInvoiceReference()
 * @method $this                                   setInvoiceReference(string $invoiceReference)
 * @method string                                  getOrderId()
 * @method $this                                   setOrderId(string $orderId)
 * @method ShipmentLineCollection                  getShipmentLines()
 * @method $this                                   setShipmentLines(array|ShipmentLineCollection $shipmentLines)
 * @method string                                  getStatus()
 * @method $this                                   setStatus(string $status)
 * @method ShipmentTracking                        getTracking()
 * @method $this                                   setTracking(array|ShipmentTracking $tracking)
 * @method \DateTime                               getCreatedDate()
 * @method $this                                   setCreatedDate(\DateTime $createdDate)
 * @method \DateTime                               getLastUpdatedDate()
 * @method $this                                   setLastUpdatedDate(\DateTime $lastUpdatedDate)
 * @method ShipmentPaymentDetails                  getPaymentDetails()
 * @method $this                                   setPaymentDetails(array|ShipmentPaymentDetails $paymentDetails)
 * @method ShipmentAdditionalInformationCollection getShipmentAdditionalInformation()
 * @method $this                                   setShipmentAdditionalInformation(array|ShipmentAdditionalInformationCollection $shipmentAdditionalInformationCollection)
 * @method \DateTime                               getShippedDate()
 * @method $this                                   setShippedDate(\DateTime $shippedDate)
 * @method ShippingFrom                            getShippingFrom()
 * @method $this                                   setShippingFrom(array|ShippingFrom $shippingFrom)
 * @method string                                  getStatusCustomerDebit() One of NO_DEBIT, NOT_STARTED, WAITING_OPERATOR_SYSTEM_CONTACT, WAITING_DEBIT_CONFIRMATION, DEBIT_OK, CANCELED
 * @method $this                                   setStatusCustomerDebit(string $statusCustomerDebit)
 */
class Shipment extends MiraklObject
{
    public const NO_DEBIT_STATUS_CUSTOMER_DEBIT                        = 'NO_DEBIT';
    public const NOT_STARTED_STATUS_CUSTOMER_DEBIT                     = 'NOT_STARTED';
    public const WAITING_TAX_CONFIRMATION_STATUS_CUSTOMER_DEBIT        = 'WAITING_TAX_CONFIRMATION';
    public const WAITING_OPERATOR_SYSTEM_CONTACT_STATUS_CUSTOMER_DEBIT = 'WAITING_OPERATOR_SYSTEM_CONTACT';
    public const WAITING_DEBIT_CONFIRMATION_STATUS_CUSTOMER_DEBIT      = 'WAITING_DEBIT_CONFIRMATION';
    public const DEBIT_OK_STATUS_CUSTOMER_DEBIT                        = 'DEBIT_OK';
    public const CANCELED_STATUS_CUSTOMER_DEBIT                        = 'CANCELED';

    /**
     * @var array
     */
    protected static $dataTypes = [
        'payment_details'                 => [ShipmentPaymentDetails::class, 'create'],
        'shipment_additional_information' => [ShipmentAdditionalInformationCollection::class, 'create'],
        'shipping_from'                   => [ShippingFrom::class, 'create'],
        'shipment_lines'                  => [ShipmentLineCollection::class, 'create'],
        'tracking'                        => [ShipmentTracking::class, 'create'],
    ];
}
