feat(Me): support me/shopping-lists endpoint

Author: nikossvnk

src/Core/Builder/Request/MeShoppingListRequestBuilder.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Builder\Request;
+
+use Commercetools\Core\Model\ShoppingList\MyShoppingListDraft;
+use Commercetools\Core\Model\ShoppingList\ShoppingList;
+use Commercetools\Core\Request\Me\MeShoppingListByIdGetRequest;
+use Commercetools\Core\Request\Me\MeShoppingListCreateRequest;
+use Commercetools\Core\Request\Me\MeShoppingListDeleteRequest;
+use Commercetools\Core\Request\Me\MeShoppingListQueryRequest;
+use Commercetools\Core\Request\Me\MeShoppingListUpdateRequest;
+
+class MeShoppingListRequestBuilder
+{
+
+    /**
+     * @return MeShoppingListQueryRequest
+     */
+    public function query()
+    {
+        return MeShoppingListQueryRequest::of();
+    }
+
+    /**
+     * @param ShoppingList $shoppingList
+     * @return MeShoppingListUpdateRequest
+     */
+    public function update(ShoppingList $shoppingList)
+    {
+        return MeShoppingListUpdateRequest::ofIdAndVersion($shoppingList->getId(), $shoppingList->getVersion());
+    }
+
+    /**
+     * @param string $shoppingListId
+     * @return MeShoppingListByIdGetRequest
+     */
+    public function getById($shoppingListId)
+    {
+        return MeShoppingListByIdGetRequest::ofId($shoppingListId);
+    }
+
+    /**
+     * @param MyShoppingListDraft $myShoppingListDraft
+     * @return MeShoppingListCreateRequest
+     */
+    public function create(MyShoppingListDraft $myShoppingListDraft)
+    {
+        return MeShoppingListCreateRequest::ofDraft($myShoppingListDraft);
+    }
+
+    /**
+     * @param ShoppingList $shoppingList
+     * @return MeShoppingListDeleteRequest
+     */
+    public function delete(ShoppingList $shoppingList)
+    {
+        return MeShoppingListDeleteRequest::ofIdAndVersion($shoppingList->getId(), $shoppingList->getVersion());
+    }
+}

src/Core/Model/ShoppingList/MyShoppingListDraft.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Model\ShoppingList;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Model\Common\Resource;
+use Commercetools\Core\Model\Common\LocalizedString;
+use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
+
+/**
+ * @package Commercetools\Core\Model\ShoppingList
+ * @link https://docs.commercetools.com/http-api-projects-me-shoppingLists#myshoppinglistdraft
+ * @method LocalizedString getName()
+ * @method MyShoppingListDraft setName(LocalizedString $name = null)
+ * @method LocalizedString getDescription()
+ * @method MyShoppingListDraft setDescription(LocalizedString $description = null)
+ * @method LineItemDraftCollection getLineItems()
+ * @method MyShoppingListDraft setLineItems(LineItemDraftCollection $lineItems = null)
+ * @method TextLineItemDraftCollection getTextLineItems()
+ * @method MyShoppingListDraft setTextLineItems(TextLineItemDraftCollection $textLineItems = null)
+ * @method CustomFieldObjectDraft getCustom()
+ * @method MyShoppingListDraft setCustom(CustomFieldObjectDraft $custom = null)
+ * @method int getDeleteDaysAfterLastModification()
+ * @method MyShoppingListDraft setDeleteDaysAfterLastModification(int $deleteDaysAfterLastModification = null)
+ */
+class MyShoppingListDraft extends Resource
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'name' => [static::TYPE => LocalizedString::class],
+            'description' => [static::TYPE => LocalizedString::class],
+            'lineItems' => [static::TYPE => LineItemDraftCollection::class],
+            'textLineItems' => [static::TYPE => TextLineItemDraftCollection::class],
+            'custom' => [static::TYPE => CustomFieldObjectDraft::class],
+            'deleteDaysAfterLastModification' => [static::TYPE => 'int'],
+        ];
+    }
+
+    /**
+     * @param LocalizedString $name
+     * @param Context|null $context
+     * @return MyShoppingListDraft
+     */
+    public static function ofName(LocalizedString $name, $context = null)
+    {
+        return static::of($context)->setName($name);
+    }
+}

src/Core/Request/Me/MeShoppingListByIdGetRequest.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Me;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractByIdGetRequest;
+use Commercetools\Core\Model\ShoppingList\ShoppingList;
+use Commercetools\Core\Response\ApiResponseInterface;
+use Commercetools\Core\Model\MapperInterface;
+
+/**
+ * @package Commercetools\Core\Request\Me
+ * @link https://docs.commercetools.com/http-api-projects-me-shoppingLists#get-shoppinglist-by-id
+ * @method ShoppingList mapResponse(ApiResponseInterface $response)
+ * @method ShoppingList mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
+ */
+class MeShoppingListByIdGetRequest extends AbstractByIdGetRequest
+{
+    protected $resultClass = ShoppingList::class;
+
+    /**
+     * @param string $id
+     * @param Context $context
+     */
+    public function __construct($id, Context $context = null)
+    {
+        parent::__construct(MeShoppingListsEndpoint::endpoint(), $id, $context);
+    }
+
+    /**
+     * @param string $id
+     * @param Context $context
+     * @return static
+     */
+    public static function ofId($id, Context $context = null)
+    {
+        return new static($id, $context);
+    }
+}

src/Core/Request/Me/MeShoppingListCreateRequest.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Me;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Model\ShoppingList\MyShoppingListDraft;
+use Commercetools\Core\Request\AbstractCreateRequest;
+use Commercetools\Core\Model\ShoppingList\ShoppingList;
+use Commercetools\Core\Response\ApiResponseInterface;
+use Commercetools\Core\Model\MapperInterface;
+
+/**
+ * @package Commercetools\Core\Request\Me
+ * @link https://docs.commercetools.com/http-api-projects-me-shoppingLists#create-a-shoppinglist
+ * @method ShoppingList mapResponse(ApiResponseInterface $response)
+ * @method ShoppingList mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
+ */
+class MeShoppingListCreateRequest extends AbstractCreateRequest
+{
+    protected $resultClass = ShoppingList::class;
+
+    /**
+     * @param MyShoppingListDraft $ShoppingList
+     * @param Context $context
+     */
+    public function __construct(MyShoppingListDraft $ShoppingList, Context $context = null)
+    {
+        parent::__construct(MeShoppingListsEndpoint::endpoint(), $ShoppingList, $context);
+    }
+
+    /**
+     * @param MyShoppingListDraft $ShoppingList
+     * @param Context $context
+     * @return static
+     */
+    public static function ofDraft(MyShoppingListDraft $ShoppingList, Context $context = null)
+    {
+        return new static($ShoppingList, $context);
+    }
+}

src/Core/Request/Me/MeShoppingListDeleteRequest.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Me;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractDeleteRequest;
+use Commercetools\Core\Model\ShoppingList\ShoppingList;
+use Commercetools\Core\Response\ApiResponseInterface;
+use Commercetools\Core\Model\MapperInterface;
+
+/**
+ * @package Commercetools\Core\Request\Me
+ * @link https://docs.commercetools.com/http-api-projects-me-shoppingLists#delete-shoppinglist
+ * @method ShoppingList mapResponse(ApiResponseInterface $response)
+ * @method ShoppingList mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
+ */
+class MeShoppingListDeleteRequest extends AbstractDeleteRequest
+{
+    protected $resultClass = ShoppingList::class;
+
+    /**
+     * @param string $id
+     * @param int $version
+     * @param Context $context
+     */
+    public function __construct($id, $version, Context $context = null)
+    {
+        parent::__construct(MeShoppingListsEndpoint::endpoint(), $id, $version, $context);
+    }
+
+    /**
+     * @param string $id
+     * @param int $version
+     * @param Context $context
+     * @return static
+     */
+    public static function ofIdAndVersion($id, $version, Context $context = null)
+    {
+        return new static($id, $version, $context);
+    }
+}

src/Core/Request/Me/MeShoppingListQueryRequest.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Me;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractQueryRequest;
+use Commercetools\Core\Model\ShoppingList\ShoppingListCollection;
+use Commercetools\Core\Response\ApiResponseInterface;
+use Commercetools\Core\Model\MapperInterface;
+
+/**
+ * @package Commercetools\Core\Request\Me
+ * @link https://docs.commercetools.com/http-api-projects-me-shoppingLists#query-shoppinglists
+ * @method ShoppingListCollection mapResponse(ApiResponseInterface $response)
+ * @method ShoppingListCollection mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
+ */
+class MeShoppingListQueryRequest extends AbstractQueryRequest
+{
+    protected $resultClass = ShoppingListCollection::class;
+
+    /**
+     * @param Context $context
+     */
+    public function __construct(Context $context = null)
+    {
+        parent::__construct(MeShoppingListsEndpoint::endpoint(), $context);
+    }
+
+    /**
+     * @param Context $context
+     * @return static
+     */
+    public static function of(Context $context = null)
+    {
+        return new static($context);
+    }
+}

src/Core/Request/Me/MeShoppingListUpdateRequest.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Me;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractUpdateRequest;
+use Commercetools\Core\Model\ShoppingList\ShoppingList;
+use Commercetools\Core\Response\ApiResponseInterface;
+use Commercetools\Core\Model\MapperInterface;
+
+/**
+ * @package Commercetools\Core\Request\Me
+ * @link https://docs.commercetools.com/http-api-projects-me-shoppingLists#update-shoppinglist
+ * @method ShoppingList mapResponse(ApiResponseInterface $response)
+ * @method ShoppingList mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
+ */
+class MeShoppingListUpdateRequest extends AbstractUpdateRequest
+{
+    protected $resultClass = ShoppingList::class;
+
+    /**
+     * @param string $id
+     * @param int $version
+     * @param array $actions
+     * @param Context $context
+     */
+    public function __construct($id, $version, array $actions = [], Context $context = null)
+    {
+        parent::__construct(MeShoppingListsEndpoint::endpoint(), $id, $version, $actions, $context);
+    }
+
+    /**
+     * @param string $id
+     * @param int $version
+     * @param Context $context
+     * @return static
+     */
+    public static function ofIdAndVersion($id, $version, Context $context = null)
+    {
+        return new static($id, $version, [], $context);
+    }
+}

src/Core/Request/Me/MeShoppingListsEndpoint.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Me;
+
+use Commercetools\Core\Client\JsonEndpoint;
+
+/**
+ * @package Commercetools\Core\Request\Me
+ */
+class MeShoppingListsEndpoint
+{
+    /**
+     * @return JsonEndpoint
+     */
+    public static function endpoint()
+    {
+        return new JsonEndpoint('me/shopping-lists');
+    }
+}