Zone can be passed in to best available calls (#123)

* Introduced BestAvailableParams

* Zone can be passed in

* Fixed test

src/Charts/Chart.php

@@ -37,7 +37,7 @@ class Chart
      */
     public $events;
     /**
-     * @var boolean
+     * @var bool
      */
     public $archived;
     /**

src/Charts/ChartListParams.php

@@ -17,22 +17,22 @@ class ChartListParams
     public $tag;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $expandEvents;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $expandValidation;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $expandVenueType;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $expandZones;
 

src/Events/BestAvailableObjects.php

@@ -13,7 +13,7 @@ class BestAvailableObjects
      */
     public $objectDetails;
     /**
-     * @var boolean
+     * @var bool
      */
     public $nextToEachOther;
 

src/Events/BestAvailableParams.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Seatsio\Events;
+
+class BestAvailableParams
+{
+    /**
+     * @var int
+     */
+    public $number;
+
+    /**
+     * @var string[]
+     */
+    public $categories;
+
+    /**
+     * @var string
+     */
+    public $zone;
+
+    /**
+     * @var array
+     */
+    public $extraData;
+
+    /**
+     * @var string[]
+     */
+    public $ticketTypes;
+
+    /**
+     * @var bool
+     */
+    public $tryToPreventOrphanSeats;
+
+    public function setNumber(int $number): self
+    {
+        $this->number = $number;
+        return $this;
+    }
+
+    public function setCategories(array $categories): self
+    {
+        $this->categories = $categories;
+        return $this;
+    }
+
+    public function setZone(string $zone): self
+    {
+        $this->zone = $zone;
+        return $this;
+    }
+
+    public function setExtraData(array $extraData): self
+    {
+        $this->extraData = $extraData;
+        return $this;
+    }
+
+    public function setTicketTypes(array $ticketTypes): self
+    {
+        $this->ticketTypes = $ticketTypes;
+        return $this;
+    }
+
+    public function setTryToPreventOrphanSeats(bool $tryToPreventOrphanSeats): self
+    {
+        $this->tryToPreventOrphanSeats = $tryToPreventOrphanSeats;
+        return $this;
+    }
+}

src/Events/Event.php

@@ -25,7 +25,7 @@ class Event
     public $date;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $supportsBestAvailable;
 

src/Events/EventObjectInfo.php

@@ -52,7 +52,7 @@ class EventObjectInfo
      */
     public $orderId;
     /**
-     * @var boolean
+     * @var bool
      */
     public $forSale;
     /**
@@ -88,15 +88,15 @@ class EventObjectInfo
      */
     public $extraData;
     /**
-     * @var boolean
+     * @var bool
      */
     public $isAccessible;
     /**
-     * @var boolean
+     * @var bool
      */
     public $isCompanionSeat;
     /**
-     * @var boolean
+     * @var bool
      */
     public $hasRestrictedView;
     /**
@@ -112,7 +112,7 @@ class EventObjectInfo
      */
     public $rightNeighbour;
     /**
-     * @var boolean
+     * @var bool
      */
     public $isAvailable;
     /**
@@ -136,7 +136,7 @@ class EventObjectInfo
      */
     public $numSeats;
     /**
-     * @var boolean
+     * @var bool
      */
     public $variableOccupancy;
     /**

src/Events/EventParams.php

@@ -22,7 +22,7 @@ abstract class EventParams
     public $date;
 
     /**
-     * @var boolean|object|array
+     * @var bool|object|array
      */
     public $tableBookingConfig;
 

src/Events/Events.php

@@ -452,13 +452,11 @@ public function book($eventKeyOrKeys, $objectOrObjects, string $holdToken = null
     }
 
     /**
-     * @param $categories string[]|null
-     * @param $ticketTypes string[]|null
      * @param $channelKeys string[]|null
      */
-    public function bookBestAvailable(string $eventKey, int $number, array $categories = null, string $holdToken = null, array $extraData = null, array $ticketTypes = null, string $orderId = null, bool $keepExtraData = null, bool $ignoreChannels = null, array $channelKeys = null): BestAvailableObjects
+    public function bookBestAvailable(string $eventKey, BestAvailableParams $bestAvailableParams, string $holdToken = null, string $orderId = null, bool $keepExtraData = null, bool $ignoreChannels = null, array $channelKeys = null): BestAvailableObjects
     {
-        return $this::changeBestAvailableObjectStatus($eventKey, $number, EventObjectInfo::$BOOKED, $categories, $holdToken, $extraData, $ticketTypes, $orderId, $keepExtraData, $ignoreChannels, $channelKeys);
+        return $this::changeBestAvailableObjectStatus($eventKey, $bestAvailableParams, EventObjectInfo::$BOOKED, $holdToken, $orderId, $keepExtraData, $ignoreChannels, $channelKeys);
     }
 
     /**
@@ -482,38 +480,36 @@ public function hold($eventKeyOrKeys, $objectOrObjects, string $holdToken, strin
     }
 
     /**
-     * @param $categories string[]|null
-     * @param $ticketTypes string[]|null
      * @param $channelKeys string[]|null
      */
-    public function holdBestAvailable(string $eventKey, int $number, string $holdToken, array $categories = null, array $extraData = null, array $ticketTypes = null, string $orderId = null, bool $keepExtraData = null, bool $ignoreChannels = null, array $channelKeys = null): BestAvailableObjects
+    public function holdBestAvailable(string $eventKey,BestAvailableParams $bestAvailableParams, string $holdToken, string $orderId = null, bool $keepExtraData = null, bool $ignoreChannels = null, array $channelKeys = null): BestAvailableObjects
     {
-        return $this::changeBestAvailableObjectStatus($eventKey, $number, EventObjectInfo::$HELD, $categories, $holdToken, $extraData, $ticketTypes, $orderId, $keepExtraData, $ignoreChannels, $channelKeys);
+        return $this::changeBestAvailableObjectStatus($eventKey, $bestAvailableParams, EventObjectInfo::$HELD, $holdToken, $orderId, $keepExtraData, $ignoreChannels, $channelKeys);
     }
 
     /**
-     * @param $categories string[]|null
-     * @param $ticketTypes string[]|null
      * @param $channelKeys string[]|null
      */
-    public function changeBestAvailableObjectStatus(string $eventKey, int $number, string $status, array $categories = null, string $holdToken = null, array $extraData = null, array $ticketTypes = null, string $orderId = null, bool $keepExtraData = null, bool $ignoreChannels = null, array $channelKeys = null, bool $tryToPreventOrphanSeats = null): BestAvailableObjects
+    public function changeBestAvailableObjectStatus(string $eventKey, BestAvailableParams $bestAvailableParams, string $status, string $holdToken = null, string $orderId = null, bool $keepExtraData = null, bool $ignoreChannels = null, array $channelKeys = null): BestAvailableObjects
     {
         $request = new stdClass();
-        $bestAvailable = new stdClass();
-        $bestAvailable->number = $number;
-        if ($categories !== null) {
-            $bestAvailable->categories = $categories;
+        $request->bestAvailable = new stdClass();
+        $request->bestAvailable->number = $bestAvailableParams->number;
+        if ($bestAvailableParams->categories !== null) {
+            $request->bestAvailable->categories = $bestAvailableParams->categories;
+        }
+        if ($bestAvailableParams->extraData != null) {
+            $request->bestAvailable->extraData = $bestAvailableParams->extraData;
         }
-        if ($extraData != null) {
-            $bestAvailable->extraData = $extraData;
+        if ($bestAvailableParams->ticketTypes !== null) {
+            $request->bestAvailable->ticketTypes = $bestAvailableParams->ticketTypes;
         }
-        if ($ticketTypes !== null) {
-            $bestAvailable->ticketTypes = $ticketTypes;
+        if ($bestAvailableParams->tryToPreventOrphanSeats !== null) {
+            $request->bestAvailable->tryToPreventOrphanSeats = $bestAvailableParams->tryToPreventOrphanSeats;
         }
-        if ($tryToPreventOrphanSeats !== null) {
-            $bestAvailable->tryToPreventOrphanSeats = $tryToPreventOrphanSeats;
+        if ($bestAvailableParams->zone !== null) {
+            $request->bestAvailable->zone = $bestAvailableParams->zone;
         }
-        $request->bestAvailable = $bestAvailable;
         $request->status = $status;
         if ($holdToken !== null) {
             $request->holdToken = $holdToken;

src/Events/ForSaleConfig.php

@@ -5,7 +5,7 @@
 class ForSaleConfig
 {
     /**
-     * @var boolean
+     * @var bool
      */
     public $forSale;
     /**

src/Events/StatusChange.php

@@ -41,7 +41,7 @@ class StatusChange
      */
     public $origin;
     /**
-     * @var boolean
+     * @var bool
      */
     public $isPresentOnChart;
     /**

src/Events/StatusChangeRequest.php

@@ -30,12 +30,12 @@ class StatusChangeRequest
     public $orderId;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $keepExtraData;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $ignoreChannels;
 

src/Reports/Usage/DetailsForMonth/Event.php

@@ -18,7 +18,7 @@ class Event
     public $key;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $deleted;
 

src/Seasons/SeasonCreationParams.php

@@ -24,7 +24,7 @@ class SeasonCreationParams
     public $numberOfEvents;
 
     /**
-     * @var boolean|object|array
+     * @var bool|object|array
      */
     public $tableBookingConfig;
 

src/Workspaces/Workspace.php

@@ -25,17 +25,17 @@ class Workspace
     public $secretKey;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $isTest;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $isDefault;
 
     /**
-     * @var boolean
+     * @var bool
      */
     public $isActive;