Merge pull request #21 from seatsio/matti/added-usage-reports

Added usage reports

src/Events/BestAvailableObjects.php

@@ -9,12 +9,12 @@ class BestAvailableObjects
      */
     public $objects;
     /**
-     * @var array[\Seatsio\Reports\EventReportItem]
+     * @var array[\Seatsio\Reports\Events\EventReportItem]
      */
     public $objectDetails;
     /**
      * @var boolean
      */
     public $nextToEachOther;
 
-}
+}

src/Events/ChangeObjectStatusResult.php

@@ -5,8 +5,8 @@
 class ChangeObjectStatusResult
 {
     /**
-     * @var array[\Seatsio\Reports\EventReportItem]
+     * @var array[\Seatsio\Reports\Events\EventReportItem]
      */
     var $objects;
 
-}
+}

src/Reports/ChartReportItem.php → src/Reports/Charts/ChartReportItem.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Seatsio\Reports;
+namespace Seatsio\Reports\Charts;
 
 class ChartReportItem
 {
@@ -36,4 +36,4 @@ class ChartReportItem
      * @var int
      */
     public $capacity;
-}
+}

src/Reports/ChartReports.php → src/Reports/Charts/ChartReports.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Seatsio\Reports;
+namespace Seatsio\Reports\Charts;
 
 use Seatsio\SeatsioJsonMapper;
 

src/Reports/EventReportItem.php → src/Reports/Events/EventReportItem.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Seatsio\Reports;
+namespace Seatsio\Reports\Events;
 
 class EventReportItem
 {

src/Reports/EventReports.php → src/Reports/Events/EventReports.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Seatsio\Reports;
+namespace Seatsio\Reports\Events;
 
 use Seatsio\SeatsioJsonMapper;
 
@@ -164,4 +164,4 @@ private static function summaryReportUrl($reportType, $eventKey)
         return \GuzzleHttp\uri_template('/reports/events/{key}/{reportType}/summary', array("key" => $eventKey, "reportType" => $reportType));
     }
 
-}
+}

src/Reports/Usage/DetailsForEventInMonth/UsageForObject.php

@@ -0,0 +1,34 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\DetailsForEventInMonth;
+
+
+class UsageForObject
+{
+
+    /**
+     * @var string
+     */
+    public $object;
+
+    /**
+     * @var int
+     */
+    public $numFirstBookings;
+
+    /**
+     * @var \DateTime
+     */
+    public $firstBookingDate;
+
+    /**
+     * @var int
+     */
+    public $numFirstSelections;
+
+    /**
+     * @var int
+     */
+    public $numFirstBookingsOrSelections;
+}

src/Reports/Usage/DetailsForMonth/Chart.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\DetailsForMonth;
+
+
+class Chart
+{
+
+    /**
+     * @var string
+     */
+    public $name;
+
+    /**
+     * @var string
+     */
+    public $key;
+}

src/Reports/Usage/DetailsForMonth/Event.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\DetailsForMonth;
+
+
+class Event
+{
+
+    /**
+     * @var int
+     */
+    public $id;
+
+    /**
+     * @var string
+     */
+    public $key;
+}

src/Reports/Usage/DetailsForMonth/Subaccount.php

@@ -0,0 +1,14 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\DetailsForMonth;
+
+
+class Subaccount
+{
+
+    /**
+     * @var int
+     */
+    public $id;
+}

src/Reports/Usage/DetailsForMonth/UsageByChart.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\DetailsForMonth;
+
+
+class UsageByChart
+{
+
+    /**
+     * @var Chart
+     */
+    public $chart;
+
+    /**
+     * @var UsageByEvent[]
+     */
+    public $usageByEvent;
+}

src/Reports/Usage/DetailsForMonth/UsageByEvent.php

@@ -0,0 +1,44 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\DetailsForMonth;
+
+
+class UsageByEvent
+{
+
+    /**
+     * @var Event
+     */
+    public $event;
+
+    /**
+     * @var int
+     */
+    public $numUsedObjects;
+
+    /**
+     * @var int
+     */
+    public $numFirstBookings;
+
+    /**
+     * @var int
+     */
+    public $numFirstBookingsOrSelections;
+
+    /**
+     * @var int
+     */
+    public $numGASelectionsWithoutBooking;
+
+    /**
+     * @var int
+     */
+    public $numNonGASelectionsWithoutBooking;
+
+    /**
+     * @var int
+     */
+    public $numObjectSelections;
+}

src/Reports/Usage/DetailsForMonth/UsageDetails.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\DetailsForMonth;
+
+
+class UsageDetails
+{
+
+    /**
+     * @var Subaccount
+     */
+    public $subaccount;
+
+    /**
+     * @var UsageByChart[]
+     */
+    public $usageByChart;
+}

src/Reports/Usage/SummaryForMonths/Month.php

@@ -0,0 +1,30 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\SummaryForMonths;
+
+
+class Month
+{
+
+    /**
+     * @var int
+     */
+    public $month;
+
+    /**
+     * @var int
+     */
+    public $year;
+
+    public function __construct($year = null, $month = null)
+    {
+        $this->year = $year;
+        $this->month = $month;
+    }
+
+    public function serialize() {
+        return $this->year . '-' . str_pad($this->month, 2, '0', STR_PAD_LEFT);
+    }
+
+}

src/Reports/Usage/SummaryForMonths/UsageSummaryForMonth.php

@@ -0,0 +1,35 @@
+<?php
+
+
+namespace Seatsio\Reports\Usage\SummaryForMonths;
+
+
+class UsageSummaryForMonth
+{
+
+    /**
+     * @var Month
+     */
+    public $month;
+
+    /**
+     * @var int
+     */
+    public $numUsedObjects;
+
+    /**
+     * @var int
+     */
+    public $numFirstBookings;
+
+    /**
+     * @var object
+     */
+    public $numFirstBookingsByStatus;
+
+    /**
+     * @var int
+     */
+    public $numFirstBookingsOrSelections;
+
+}

src/Reports/Usage/UsageReports.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Seatsio\Reports\Usage;
+
+use Seatsio\Reports\Usage\DetailsForEventInMonth\UsageForObject;
+use Seatsio\Reports\Usage\DetailsForMonth\UsageDetails;
+use Seatsio\Reports\Usage\SummaryForMonths\Month;
+use Seatsio\Reports\Usage\SummaryForMonths\UsageSummaryForMonth;
+use Seatsio\SeatsioJsonMapper;
+
+class UsageReports
+{
+
+    /**
+     * @var \GuzzleHttp\Client
+     */
+    private $client;
+
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * @return UsageSummaryForMonth[]
+     */
+    public function summaryForAllMonths()
+    {
+        $res = $this->client->get('/reports/usage');
+        $json = \GuzzleHttp\json_decode($res->getBody());
+        $mapper = SeatsioJsonMapper::create();
+        return $mapper->mapArray($json, array(), UsageSummaryForMonth::class);
+    }
+
+    /**
+     * @param Month $month
+     * @return UsageDetails[]
+     */
+    public function detailsForMonth($month)
+    {
+        $res = $this->client->get('/reports/usage/month/' . $month->serialize());
+        $json = \GuzzleHttp\json_decode($res->getBody());
+        $mapper = SeatsioJsonMapper::create();
+        return $mapper->mapArray($json, array(), UsageDetails::class);
+    }
+
+    /**
+     * @param int $eventId
+     * @param Month $month
+     * @return UsageForObject[]
+     */
+    public function detailsForEventInMonth($eventId, $month)
+    {
+        $res = $this->client->get('/reports/usage/month/' . $month->serialize() . '/event/' . $eventId);
+        $json = \GuzzleHttp\json_decode($res->getBody());
+        $mapper = SeatsioJsonMapper::create();
+        return $mapper->mapArray($json, array(), UsageForObject::class);
+    }
+
+}