-
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New endpoints for eshops orders (#9)
* Extends api for orders eshops * Setters in model * FIx order item property * Fixes * Refactor - Abstract orders * Refactor readme and remove unused orders abstract constructor * Import 'SmartEmailing\v3\Api' is never used * Return types Api * Fix status order canceled Co-authored-by: Lukas Skywalker <lukas.paiskr@bootiq.io>
- Loading branch information
Showing
16 changed files
with
1,376 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| <?php | ||
|
|
||
|
|
||
| namespace SmartEmailing\v3\Request\Eshops; | ||
|
|
||
| use JsonSerializable; | ||
| use SmartEmailing\v3\Request\AbstractRequest; | ||
| use SmartEmailing\v3\Request\Eshops\Model\Order; | ||
|
|
||
| /** | ||
| * Class AbstractEshopOrders | ||
| * @package SmartEmailing\v3\Request\Eshops | ||
| */ | ||
| abstract class AbstractEshopOrders extends AbstractRequest implements JsonSerializable | ||
| { | ||
| /** | ||
| * @var Order[] | ||
| */ | ||
| protected array $orders = []; | ||
|
|
||
| /** | ||
| * Creates Returns the newly created order | ||
| * | ||
| * @param $eshopName | ||
| * @param $eshopCode | ||
| * @param $emailAddress | ||
| * | ||
| * @return Order | ||
| */ | ||
| public function newOrder($eshopName, $eshopCode, $emailAddress): Order | ||
| { | ||
| $order = new Order($eshopName, $eshopCode, $emailAddress); | ||
| $this->addOrder($order); | ||
| return $order; | ||
| } | ||
|
|
||
| /** | ||
| * @param Order $order | ||
| * | ||
| * @return AbstractEshopOrders | ||
| */ | ||
| public function addOrder(Order $order): AbstractEshopOrders | ||
| { | ||
| $this->orders[] = $order; | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return Order[] | ||
| */ | ||
| public function orders(): array | ||
| { | ||
| return $this->orders; | ||
| } | ||
|
|
||
| /** | ||
| * @return array[] | ||
| */ | ||
| protected function options(): array | ||
| { | ||
| return [ | ||
| 'json' => $this->jsonSerialize() | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| protected function method(): string | ||
| { | ||
| return 'POST'; | ||
| } | ||
|
|
||
| /** | ||
| * @return array | ||
| */ | ||
| public function jsonSerialize(): array | ||
| { | ||
| return $this->toArray(); | ||
| } | ||
| /** | ||
| * Converts data to array | ||
| * @return array | ||
| */ | ||
| public function toArray(): array | ||
| { | ||
| return $this->orders; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| namespace SmartEmailing\v3\Request\Eshops; | ||
|
|
||
| use SmartEmailing\v3\Request\Eshops\Model\Order; | ||
|
|
||
| /** | ||
| * Class Orders | ||
| * @package SmartEmailing\v3\Request\Eshops | ||
| */ | ||
| class EshopOrders extends AbstractEshopOrders implements \JsonSerializable | ||
| { | ||
| /** | ||
| * @param $order | ||
| * | ||
| * @return EshopOrders | ||
| */ | ||
| public function addOrder(Order $order): EshopOrders | ||
| { | ||
| $this->orders = []; | ||
| parent::addOrder($order); | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return Order|null | ||
| */ | ||
| public function order(): ?Order | ||
| { | ||
| if (count($this->orders)) { | ||
| return current($this->orders); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| protected function endpoint(): string | ||
| { | ||
| return 'orders'; | ||
| } | ||
|
|
||
| /** | ||
| * Converts data to array | ||
| * @return array | ||
| */ | ||
| public function toArray(): array | ||
| { | ||
| if (is_null($this->order())) { | ||
| return []; | ||
| } | ||
| return $this->order()->toArray(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| <?php | ||
|
|
||
| namespace SmartEmailing\v3\Request\Eshops; | ||
|
|
||
| use SmartEmailing\v3\Request\Response; | ||
|
|
||
| /** | ||
| * Class OrdersBulk | ||
| * Method is used to import orders in bulk. Up to 500 orders per request is allowed. | ||
| * This creates new activities which can be used for scoring, segmentation and automation. | ||
| * | ||
| * @package SmartEmailing\v3\Request\Eshops | ||
| */ | ||
| class EshopOrdersBulk extends AbstractEshopOrders implements \JsonSerializable | ||
| { | ||
| /** | ||
| * The maximum orders per single request | ||
| * @var int | ||
| */ | ||
| public int $chunkLimit = 500; | ||
|
|
||
| /** | ||
| * Will send multiple requests because of the 500 count limit | ||
| * @inheritDoc | ||
| */ | ||
| public function send(): ?Response | ||
| { | ||
| // There is not enough contacts to enable chunk mode | ||
| if ($this->chunkLimit >= count($this->orders)) { | ||
| return parent::send(); | ||
| } | ||
|
|
||
| return $this->sendInChunkMode(); | ||
| } | ||
|
|
||
| /** | ||
| * Sends contact list in chunk mode | ||
| * @return Response | ||
| */ | ||
| protected function sendInChunkMode(): Response | ||
| { | ||
| // Store the original contact list | ||
| $originalFullOrdersList = $this->orders; | ||
| $lastResponse = null; | ||
|
|
||
| // Chunk the array of contacts send it in multiple requests | ||
| foreach (array_chunk($this->orders, $this->chunkLimit) as $orders) { | ||
| // Store the contacts that will be passed | ||
| $this->orders = $orders; | ||
|
|
||
| $lastResponse = parent::send(); | ||
| } | ||
|
|
||
| // Restore to original array | ||
| $this->orders = $originalFullOrdersList; | ||
|
|
||
| return $lastResponse; | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| protected function endpoint(): string | ||
| { | ||
| return 'orders-bulk'; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.