<?php
/**
 *
 *          ..::..
 *     ..::::::::::::..
 *   ::'''''':''::'''''::
 *   ::..  ..:  :  ....::
 *   ::::  :::  :  :   ::
 *   ::::  :::  :  ''' ::
 *   ::::..:::..::.....::
 *     ''::::::::::::''
 *          ''::''
 *
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Creative Commons License.
 * It is available through the world-wide-web at this URL:
 * http://creativecommons.org/licenses/by-nc-nd/3.0/nl/deed.en_US
 * If you are unable to obtain it through the world-wide-web, please send an email
 * to servicedesk@tig.nl so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade this module to newer
 * versions in the future. If you wish to customize this module for your
 * needs please contact servicedesk@tig.nl for more information.
 *
 * @copyright   Copyright (c) Total Internet Group B.V. https://tig.nl/copyright
 * @license     http://creativecommons.org/licenses/by-nc-nd/3.0/nl/deed.en_US
 */
namespace TIG\PostNL\Api;

interface ShipmentRepositoryInterface
{
    /**
     * Update a PostNL shipment.
     *
     * @api
     * @param \TIG\PostNL\Api\Data\ShipmentInterface $shipment
     * @return \TIG\PostNL\Api\Data\ShipmentInterface
     */
    public function save(\TIG\PostNL\Api\Data\ShipmentInterface $shipment);

    /**
     * Create a PostNL shipment.
     *
     * @api
     * @return \TIG\PostNL\Api\Data\ShipmentInterface
     */
    public function create();

    /**
     * Retrieve a specific PostNL shipment.
     *
     * @api
     * @param int $id
     * @return \TIG\PostNL\Api\Data\ShipmentInterface
     */
    // @codingStandardsIgnoreLine
    public function getById($id);

    /**
     * Find one row by field with specific value.
     *
     * @api
     * @param string $field
     * @param string|int $value
     *
     * @return \TIG\PostNL\Api\Data\ShipmentInterface|null
     */
    public function getByFieldWithValue($field, $value);

    /**
     * Retrieve a specific PostNL shipment by the Magento Shipment ID.
     *
     * @param int $id
     * @return \TIG\PostNL\Api\Data\ShipmentInterface
     */
    // @codingStandardsIgnoreLine
    public function getByShipmentId($id);

    /**
     * Retrieve a list of PostNL shipments.
     *
     * @api
     * @param \Magento\Framework\Api\SearchCriteriaInterface $criteria
     * @return \Magento\Framework\Api\SearchResultsInterface
     */
    public function getList(\Magento\Framework\Api\SearchCriteriaInterface $criteria);

    /**
     * Delete a PostNL order.
     *
     * @param \TIG\PostNL\Api\Data\ShipmentInterface $shipment
     * @return bool
     */
    public function delete(\TIG\PostNL\Api\Data\ShipmentInterface $shipment);

    /**
     * Delete a PostNL shipment.
     *
     * @api
     * @param $id
     * @return bool
     */
    // @codingStandardsIgnoreLine
    public function deleteById($id);
}