Merge pull request #13 from novuhq/add-more-features

Notifications, Inbound Parse Functionality

Author: unicodeveloper

README.md

@@ -28,13 +28,15 @@ composer require unicodeveloper/novu
     * [Topics](#topics)
     * [Activity](#activity)
     * [Integrations](#integrations)
+    * [Notifications](#notifications)
     * [Notification Templates](#notification-templates)
     * [Notification Groups](#notification-groups)
     * [Changes](#changes)
     * [Environments](#environments)
     * [Feeds](#feeds)
     * [Messages](#messages)
     * [Execution Details](#execution-details)
+    * [Validate the MX Record setup for Inbound Parse functionality](#validate-the-mx-record-setup-for-inbound-parse-functionality)
 * [License](#license)
 
 ## Usage
@@ -270,6 +272,36 @@ $novu->deleteIntegration($integrationId);
 
 ```
 
+## NOTIFICATIONS
+
+```php
+
+// Get all notifications
+$novu->getNotifications()->toArray();
+
+// Get all notifications with query parameters
+$queryParams = [
+    'page' => 3
+];
+$novu->getNotifications($queryParams)->toArray();
+
+// Get one notification 
+$novu->getNotification($notificationId)->toArray();
+
+// Get notification stats
+$novu->getNotificationStats()->toArray();
+
+// Get Notification graph stats
+$novu->getNotificationGraphStats()->toArray();
+
+// Get Notification graph stats with query parameters
+$queryParams = [
+    'days' => 5
+];
+$novu->getNotificationGraphStats($queryParams)->toArray();
+
+```
+
 ## NOTIFICATION TEMPLATES
 
 ```php
@@ -428,6 +460,15 @@ $novu->getExecutionDetails([
 
 ```
 
+## Validate the MX Record setup for Inbound Parse functionality
+
+```php
+
+// Validate MX Record for Inbound Parse
+$novu->validateMXRecordForInboundParse()->toArray();
+
+```
+
 ## License
 
 **Novu PHP SDK** was created by **[Prosper Otemuyiwa](https://twitter.com/unicodeveloper)** under the **[MIT license](https://opensource.org/licenses/MIT)**.

src/Actions/ManagesInboundParse.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Novu\SDK\Actions;
+
+use Novu\SDK\Resources\InboundParse;
+
+trait ManagesInboundParse
+{
+   
+    /**
+     * Validate the MX Record setup for Inbound Parse functionality
+     *
+     * @return \Novu\SDK\Resources\InboundParse
+     */
+    public function validateMXRecordForInboundParse()
+    {
+        $record = $this->get("inbound-parse/mx/status")['data'];
+
+        return new InboundParse($record, $this);
+    }
+}

src/Actions/ManagesNotifications.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Novu\SDK\Actions;
+
+use Novu\SDK\Resources\Notification;
+use Novu\SDK\Resources\NotificationStats;
+use Novu\SDK\Resources\NotificationGraphStats;
+
+trait ManagesNotifications
+{
+   
+    /**
+     * Get A Notification
+     *
+     * @param  string $notificationId
+     * @return \Novu\SDK\Resources\Notification
+     */
+    public function getNotification($notificationId)
+    {
+        $response = $this->get("notifications/{$notificationId}")['data'];
+
+        return new Notification($response, $this);
+    }
+
+     /**
+     * Get All Notifications
+     * @param array $queryParams
+     * @return \Novu\SDK\Resources\Notification
+     */
+    public function getNotifications(array $queryParams = [])
+    {
+        $uri = "notifications";
+
+        if(! empty($queryParams)) {
+            $uri .= '?' . http_build_query($queryParams);
+        }
+
+        $response = $this->get($uri);
+
+        return new Notification($response, $this);
+    }
+
+     /**
+     * Get Notification Statistics 
+     *
+     * @return \Novu\SDK\Resources\NotificationStats
+     */
+    public function getNotificationStats()
+    {
+        $response = $this->get("notifications/stats")['data'];
+
+        return new NotificationStats($response, $this);
+    }
+
+    /**
+     * Get Notification Graph Stats
+     * @param array $queryParams
+     * @return \Novu\SDK\Resources\NotificationGraphStats
+     */
+    public function getNotificationGraphStats(array $queryParams = [])
+    {
+        $uri = "notifications/graph/stats";
+
+        if(! empty($queryParams)) {
+            $uri .= '?' . http_build_query($queryParams);
+        }
+
+        $response = $this->get($uri)['data'];
+    
+        return new NotificationGraphStats($response, $this);
+    }
+
+}

src/Novu.php

@@ -12,6 +12,8 @@ class Novu
         Actions\ManagesTopics,
         Actions\ManagesSubscribers,
         Actions\ManagesActivity,
+        Actions\ManagesInboundParse,
+        Actions\ManagesNotifications,
         Actions\ManagesChanges,
         Actions\ManagesEnvironments,
         Actions\ManagesExecutionDetails,

src/Resources/InboundParse.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Novu\SDK\Resources;
+
+class InboundParse extends Resource
+{
+    /**
+     * The mxRecordConfigured status
+     *
+     * @var bool
+     */
+    public $mxRecordConfigured;
+
+    /**
+     * Return the array form of InboundParse object.
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+        return [
+            'mxRecordConfigured' => $this->mxRecordConfigured
+        ];
+    }
+}

src/Resources/Notification.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Novu\SDK\Resources;
+
+class Notification extends Resource
+{
+    /**
+     * The internal id Novu generated
+     *
+     * @var string
+     */
+    public $id;
+
+    /**
+     * The environment Id
+     *
+     * @var string
+     */
+    public $environmentId;
+
+    /**
+     * The organization id
+     *
+     * @var string
+     */
+    public $organizationId;
+
+    /**
+     * The transaction id
+     *
+     * @var string
+     */
+    public $transactionId;
+
+    /**
+     * The createdAt
+     *
+     * @var string
+     */
+    public $createdAt;
+
+    /**
+     * The channels
+     *
+     * @var array
+     */
+    public $channels;
+
+    /**
+     * The subscriber
+     *
+     * @var array
+     */
+    public $subscriber;
+
+    /**
+     * The template
+     *
+     * @var array
+     */
+    public $template;
+
+    /**
+     * The jobs
+     *
+     * @var string
+     */
+    public $jobs;
+
+
+    /**
+     * Return the array form of Notification object.
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+
+        $publicProperties = get_object_vars($this);
+
+        unset($publicProperties['attributes']);
+        unset($publicProperties['novu']);
+
+        return array_filter($publicProperties, function ($value) { 
+            return null !== $value;
+        });
+    }
+}

src/Resources/NotificationGraphStats.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Novu\SDK\Resources;
+
+class NotificationGraphStats extends Resource
+{
+    /**
+     * The internal id Novu generated
+     *
+     * @var string
+     */
+    public $id;
+
+    /**
+     * The count
+     *
+     * @var integer
+     */
+    public $count;
+
+    /**
+     * The templates
+     *
+     * @var array
+     */
+    public $templates;
+
+    /**
+     * The channels
+     *
+     * @var array
+     */
+    public $channels;
+
+
+    /**
+     * Return the array form of Notification Graph Stats
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+        $publicProperties = get_object_vars($this);
+
+        unset($publicProperties['attributes']);
+        unset($publicProperties['novu']);
+
+        return array_filter($publicProperties, function ($value) { 
+            return null !== $value;
+        });
+    }
+}

src/Resources/NotificationStats.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Novu\SDK\Resources;
+
+class NotificationStats extends Resource
+{
+    /**
+     * The weekly sent count
+     *
+     * @var integer
+     */
+    public $weeklySent;
+
+    /**
+     * The monthly sent count
+     *
+     * @var integer
+     */
+    public $monthlySent;
+
+    /**
+     * The yearly sent count
+     *
+     * @var integer
+     */
+    public $yearlySent;
+
+    /**
+     * Return the array form of Notification Stats object.
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+        return [
+            'weeklySent' => $this->weeklySent,
+            'monthlySent' => $this->monthlySent,
+            'yearlySent' => $this->yearlySent,
+        ];
+    }
+}