#13 - order status update

README.md

@@ -71,6 +71,7 @@ foreach ($stores as $store) {
 ### SDK resources documentation
 
 - [Inventory management](docs/catalog.md)
+- [Order management](docs/order.md)
 
 
 ### Generates XML compliant feed for import

composer.json

@@ -23,8 +23,8 @@
   },
   "scripts": {
     "test": [
-      "@php vendor/bin/phpcs --colors --report=full --standard=resources/phpcs/ruleset.xml --report-checkstyle=build/phpcs/phpcs.xml --report-emacs=build/phpcs/phpcs.log --extensions=php -p src",
-      "@php vendor/bin/phpunit --configuration=phpunit.xml --coverage-html=build/phpunit/coverage/"
+      "@php vendor/bin/phpunit --configuration=phpunit.xml --coverage-html=build/phpunit/coverage/",
+      "@php vendor/bin/phpcs --colors --report=full --standard=resources/phpcs/ruleset.xml --report-checkstyle=build/phpcs/phpcs.xml --report-emacs=build/phpcs/phpcs.log --extensions=php -p src"
     ]
   },
   "scripts-descriptions": {

docs/inventory.md

@@ -6,7 +6,7 @@ Accessing to the inventory API can be done from store resource
 
 ```php
 <?php
-$inventoryApi = $session->getMainStore()->getInventory();
+$inventoryApi = $session->getMainStore()->getInventoryApi();
 ```
 
 Find a inventory item by product's reference (sku):

docs/order.md

@@ -0,0 +1,99 @@
+# Order
+
+## Access
+
+Accessing order operation can be done from the store.
+
+```php
+<?php
+$orderApi = $session->getMainStore()->getOrderApi();
+```
+
+## Operations
+
+From order API you can then access all available operation :
+```php
+<?php
+/** @var \ShoppingFeed\Sdk\Api\Order\OrderDomain $orderApi */
+$orderApi
+    ->newOperations()
+    ->accept('ref3', 'amazon')
+    ->refuse('ref4', 'amazon')
+    ->ship('ref5', 'amazon')
+    ->cancel('ref1', 'amazon')
+    ->execute();
+```
+
+### Accept
+
+The accept operation accept 3 parameters :
+1. [mandatory] `$reference` : Order reference (eg: 'reference1') 
+2. [mandatory] `$channelName` : The channel where the order is from (eg: 'amazon') 
+3. [optional] `$reason` : The reason of the acceptance (eq: 'Why we accept the order') 
+
+Example :
+```php
+<?php
+/** @var \ShoppingFeed\Sdk\Api\Order\OrderDomain $orderApi */
+$orderApi
+    ->newOperations()
+    ->accept('ref1', 'amazon')
+    ->accept('ref2', 'amazon', 'Why we accept it')
+    ->execute();
+```
+
+### Cancel
+
+The cancel operation accept 3 parameters :
+1. [mandatory] `$reference` : Order reference (eg: 'reference1') 
+2. [mandatory] `$channelName` : The channel where the order is from (eg: 'amazon') 
+3. [optional] `$reason` : The reason of the cancelling (eq: 'Why we cancel the order') 
+
+Example :
+```php
+<?php
+/** @var \ShoppingFeed\Sdk\Api\Order\OrderDomain $orderApi */
+$orderApi
+    ->newOperations()
+    ->cancel('ref1', 'amazon')
+    ->cancel('ref2', 'amazon', 'Why we accept it')
+    ->execute();
+```
+
+### Refuse
+
+The refuse operation accept 3 parameters :
+1. [mandatory] `$reference` : Order reference (eg: 'reference1') 
+2. [mandatory] `$channelName` : The channel where the order is from (eg: 'amazon') 
+3. [optional] `$refund` : Item references to refund (eq: `['itemref1', 'itemref2']`) 
+
+Example :
+```php
+<?php
+/** @var \ShoppingFeed\Sdk\Api\Order\OrderDomain $orderApi */
+$orderApi
+    ->newOperations()
+    ->refuse('ref1', 'amazon')
+    ->refuse('ref2', 'amazon', ['itemref1', 'itemref2'])
+    ->execute();
+```
+
+### Ship
+
+The ship operation accept 3 parameters :
+1. [mandatory] `$reference` : Order reference (eg: 'reference1') 
+2. [mandatory] `$channelName` : The channel where the order is from (eg: 'amazon') 
+3. [optional] `$carrier` : The carrier name used for the shipment (eq: 'ups') 
+3. [optional] `$trackingNumber` : Tracking number (eq: '01234598abcdef') 
+3. [optional] `$trackingLink` : Tracking link (eq: 'http://tracking.url/') 
+
+Example :
+```php
+<?php
+/** @var \ShoppingFeed\Sdk\Api\Order\OrderDomain $orderApi */
+$orderApi
+    ->newOperations()
+    ->ship('ref1', 'amazon')
+    ->ship('ref2', 'amazon', 'ups', '123456789abcdefg', 'http://tracking.url/')
+    ->execute();
+```

src/Api/Order/OrderCollection.php

@@ -0,0 +1,9 @@
+<?php
+namespace ShoppingFeed\Sdk\Api\Order;
+
+use ShoppingFeed\Sdk\Resource\AbstractCollection;
+
+class OrderCollection extends AbstractCollection
+{
+    protected $resourceClass = OrderResource::class;
+}

src/Api/Order/OrderDomain.php

@@ -0,0 +1,142 @@
+<?php
+namespace ShoppingFeed\Sdk\Api\Order;
+
+use ShoppingFeed\Sdk\Api\Order as ApiOrder;
+use ShoppingFeed\Sdk\Order\OrderOperation;
+use ShoppingFeed\Sdk\Resource\AbstractDomainResource;
+
+/**
+ * @method ApiOrder\OrderResource[] getIterator()
+ * @method ApiOrder\OrderResource[] getAll($page = 1, $limit = 100)
+ */
+class OrderDomain extends AbstractDomainResource
+{
+    /**
+     * @var OrderOperation
+     */
+    private $orderOperations;
+
+    /**
+     * @var string
+     */
+    protected $resourceClass = ApiOrder\OrderResource::class;
+
+    /**
+     * Init new order operation queue
+     *
+     * @return OrderDomain
+     */
+    public function newOperations($orderOperation = null)
+    {
+        $this->orderOperations = $orderOperation;
+        if (! $this->orderOperations) {
+            $this->orderOperations = new OrderOperation();
+        }
+
+        return $this;
+    }
+
+    /**
+     * Notify market place of order acceptance
+     *
+     * @param string $reference   Order reference
+     * @param string $channelName Channel to notify
+     * @param string $reason      Optional reason of acceptance
+     *
+     * @return OrderDomain
+     *
+     * @throws \Exception
+     */
+    public function accept($reference, $channelName, $reason = '')
+    {
+        $this->orderOperations->addOperation(
+            $reference,
+            $channelName,
+            OrderOperation::TYPE_ACCEPT,
+            compact('reason')
+        );
+
+        return $this;
+    }
+
+    /**
+     * Notify market place of order cancellation
+     *
+     * @param string $reference   Order reference
+     * @param string $channelName Channel to notify
+     * @param string $reason      Optional reason of cancellation
+     *
+     * @return OrderDomain
+     *
+     * @throws \Exception
+     */
+    public function cancel($reference, $channelName, $reason = '')
+    {
+        $this->orderOperations->addOperation(
+            $reference,
+            $channelName,
+            OrderOperation::TYPE_CANCEL,
+            compact('reason')
+        );
+
+        return $this;
+    }
+
+    /**
+     * Notify market place of order shipment sent
+     *
+     * @param string $reference      Order reference
+     * @param string $channelName    Channel to notify
+     * @param string $carrier        Optional carrier name
+     * @param string $trackingNumber Optional tracking number
+     * @param string $trackingLink   Optional tracking link
+     *
+     * @return OrderDomain
+     *
+     * @throws \Exception
+     */
+    public function ship($reference, $channelName, $carrier = '', $trackingNumber = '', $trackingLink = '')
+    {
+        $this->orderOperations->addOperation(
+            $reference,
+            $channelName,
+            OrderOperation::TYPE_SHIP,
+            compact('carrier', 'trackingNumber', 'trackingLink')
+        );
+
+        return $this;
+    }
+
+    /**
+     * Notify market place of order refusal
+     *
+     * @param string $reference Order reference
+     * @param string $channelName    Channel to notify
+     * @param array  $refund    Order item reference that will be refunded
+     *
+     * @return OrderDomain
+     *
+     * @throws \Exception
+     */
+    public function refuse($reference, $channelName, $refund = [])
+    {
+        $this->orderOperations->addOperation(
+            $reference,
+            $channelName,
+            OrderOperation::TYPE_REFUSE,
+            compact('refund')
+        );
+
+        return $this;
+    }
+
+    /**
+     * Execute order operations
+     *
+     * @return mixed|OrderCollection
+     */
+    public function execute()
+    {
+        return $this->orderOperations->execute($this->link);
+    }
+}

src/Api/Order/OrderResource.php

@@ -0,0 +1,105 @@
+<?php
+namespace ShoppingFeed\Sdk\Api\Order;
+
+use ShoppingFeed\Sdk\Resource\AbstractResource;
+
+class OrderResource extends AbstractResource
+{
+    /**
+     * @return int
+     */
+    public function getId()
+    {
+        return (int) $this->getProperty('id');
+    }
+
+    /**
+     * @return string
+     */
+    public function getReference()
+    {
+        return (string) $this->getProperty('reference');
+    }
+
+    /**
+     * @return null|string
+     */
+    public function getStoreReference()
+    {
+        return $this->getProperty('storeReference');
+    }
+
+    /**
+     * @return string
+     */
+    public function getStatus()
+    {
+        return (string) $this->getProperty('status');
+    }
+
+    /**
+     * @return false|\DateTimeImmutable
+     */
+    public function getAcknowledgedAt()
+    {
+        $dateValue = $this->getProperty('acknowledgedAt');
+        if (false === $dateValue) {
+            return false;
+        }
+
+        return date_create_immutable(is_null($dateValue) ? 'now' : $dateValue);
+    }
+
+    /**
+     * @return false|\DateTimeImmutable
+     */
+    public function getUpdateddAt()
+    {
+        $dateValue = $this->getProperty('updatedAt');
+        if (false === $dateValue) {
+            return false;
+        }
+
+        return date_create_immutable(is_null($dateValue) ? 'now' : $dateValue);
+    }
+
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function getCreatedAt()
+    {
+        return date_create_immutable($this->getProperty('createdAt'));
+    }
+
+    /**
+     * @return array
+     */
+    public function getShippingAddress()
+    {
+        return $this->getProperty('shippingAddress');
+    }
+
+    /**
+     * @return array
+     */
+    public function getBillingAddress()
+    {
+        return $this->getProperty('billingAddress');
+    }
+
+    /**
+     * @return array
+     */
+    public function getPaymentInformation()
+    {
+        return $this->getProperty('payment');
+    }
+
+    /**
+     * @return array
+     */
+    public function getShipment()
+    {
+        return $this->getProperty('shipment');
+    }
+}