added a way to get subscribers by type

phpdoc blocks

Author: DomasWEB

src/Api/Campaigns.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Campaigns
+ *
+ * @package MailerLiteApi\Api
+ */
 class Campaigns extends ApiAbstract {
 
     protected $endpoint = 'campaigns';
@@ -78,4 +83,4 @@ public function get($type = 'sent', $fields = ['*'])
 
         return $entities;
     }
-}
+}

src/Api/Fields.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Fields
+ *
+ * @package MailerLiteApi\Api
+ */
 class Fields extends ApiAbstract {
 
     protected $endpoint = 'fields';
@@ -15,4 +20,4 @@ public function getAccountFields() {
         return $response['body'];
     }
 
-}
+}

src/Api/Groups.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Groups
+ *
+ * @package MailerLiteApi\Api
+ */
 class Groups extends ApiAbstract {
 
     protected $endpoint = 'groups';
@@ -102,4 +107,4 @@ public function importSubscribers(
 
         return $response['body'];
     }
-}
+}

src/Api/Segments.php

@@ -4,8 +4,13 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Segments
+ *
+ * @package MailerLiteApi\Api
+ */
 class Segments extends ApiAbstract {
 
     protected $endpoint = 'segments';
 
-}
+}

src/Api/Settings.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Settings
+ *
+ * @package MailerLiteApi\Api
+ */
 class Settings extends ApiAbstract {
 
     protected $endpoint = 'settings';
@@ -33,4 +38,4 @@ public function setDoubleOptin( $status ) {
         return $response['body'];
     }
 
-}
+}

src/Api/Stats.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Stats
+ *
+ * @package MailerLiteApi\Api
+ */
 class Stats extends ApiAbstract {
 
     protected $endpoint = 'stats';
@@ -22,4 +27,4 @@ public function getHistorical($timestamp)
         return $response['body'];
     }
 
-}
+}

src/Api/Subscribers.php

@@ -4,8 +4,19 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Subscribers
+ *
+ * @package MailerLiteApi\Api
+ */
 class Subscribers extends ApiAbstract {
 
+    const TYPE_ACTIVE = 'active';
+    const TYPE_UNSUBSCRIBED = 'unsubscribed';
+    const TYPE_BOUNCED = 'bounced';
+    const TYPE_JUNK = 'junk';
+    const TYPE_UNCONFIRMED = 'unconfirmed';
+
     protected $endpoint = 'subscribers';
 
     /**
@@ -66,4 +77,29 @@ public function search($query)
         return $response['body'];
     }
 
-}
+    /**
+     * Get all subscribers
+     *
+     * @param  string[]  $fields
+     * @param  null|string  $type
+     *
+     * @return \MailerLiteApi\Common\Collection
+     */
+    public function get($fields = ['*'], $type = null)
+    {
+        $params = $this->prepareParams();
+
+        if ( ! empty($fields) && is_array($fields) && $fields != ['*']) {
+            $params['fields'] = $fields;
+        }
+
+        if ($type !== null) {
+            $params['type'] = $type;
+        }
+
+        $response = $this->restClient->get($this->endpoint, $params);
+
+        return $this->generateCollection($response['body']);
+    }
+
+}

src/Api/WooCommerce.php

@@ -1,10 +1,14 @@
 <?php
 
-
 namespace MailerLiteApi\Api;
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class WooCommerce
+ *
+ * @package MailerLiteApi\Api
+ */
 class WooCommerce extends ApiAbstract
 {
     protected $endpoint = 'woocommerce';
@@ -101,4 +105,4 @@ public function validateAccount()
         $endpoint = 'woocommerce/initial_account_settings';
         return $this->restClient->get($endpoint);
     }
-}
+}