Add "Get Webhooks" endpoint #187

src/BigCommerce/Api/Webhooks/WebhooksApi.php

@@ -2,23 +2,38 @@
 
 namespace BigCommerce\ApiV3\Api\Webhooks;
 
-use BigCommerce\ApiV3\Api\Generic\GetResource;
-use BigCommerce\ApiV3\Api\Generic\V3ApiBase;
+use BigCommerce\ApiV3\Api\Generic\ResourceApi;
 use BigCommerce\ApiV3\ResponseModels\Webhook\WebhookResponse;
+use BigCommerce\ApiV3\ResponseModels\Webhook\WebhooksResponse;
 
-class WebhooksApi extends V3ApiBase
+class WebhooksApi extends ResourceApi
 {
-    use GetResource;
-
     public const WEBHOOK_ENDPOINT = 'hooks/%d';
+    public const WEBHOOKS_ENDPOINT = 'hooks';
+    public const RESOURCE_NAME = 'hooks';
 
-    public function singleResourceUrl(): string
+    public function get(): WebhookResponse
+    {
+        return new WebhookResponse($this->getResource());
+    }
+
+    protected function singleResourceEndpoint(): string
     {
         return self::WEBHOOK_ENDPOINT;
     }
 
-    public function get(): WebhookResponse
+    protected function multipleResourcesEndpoint(): string
     {
-        return new WebhookResponse($this->getResource());
+        return self::WEBHOOKS_ENDPOINT;
+    }
+
+    protected function resourceName(): string
+    {
+        return self::RESOURCE_NAME;
+    }
+
+    public function getAll(array $filters = [], int $page = 1, int $limit = 250): WebhooksResponse
+    {
+        return new WebhooksResponse($this->getAllResources($filters, $page, $limit));
     }
 }

src/BigCommerce/Client.php

@@ -229,6 +229,11 @@ public function webhook(int $id): WebhooksApi
         return new WebhooksApi($this, $id);
     }
 
+    public function webhooks(): WebhooksApi
+    {
+        return new WebhooksApi($this);
+    }
+
     protected function defaultBaseUrl(): string
     {
         return self::API_URI;

src/BigCommerce/ResponseModels/Webhook/WebhooksResponse.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResponseModels\Webhook;
+
+use BigCommerce\ApiV3\ResourceModels\Webhook\Webhook;
+use BigCommerce\ApiV3\ResponseModels\PaginatedResponse;
+
+class WebhooksResponse extends PaginatedResponse
+{
+    /**
+     * @return Webhook[]
+     */
+    public function getWebhooks(): array
+    {
+        return $this->getData();
+    }
+    protected function resourceClass(): string
+    {
+        return Webhook::class;
+    }
+}

tests/BigCommerce/Api/Webhooks/WebhooksApiTest.php

@@ -14,4 +14,11 @@ public function testCanGetWebhook()
         $this->assertEquals('https://665b65a6.ngrok.io/webhooks', $webhook->destination);
         $this->assertEquals('string', $webhook->headers['custom']);
     }
-}
+
+    public function testCanGetWebhooks()
+    {
+        $this->setReturnData('webhooks__get_all.json');
+        $webhooks = $this->getApi()->webhooks()->getAll()->getWebhooks();
+        $this->assertEquals('store/order/*', $webhooks[0]->scope);
+    }
+}

tests/BigCommerce/responses/webhooks__get_all.json

@@ -0,0 +1,16 @@
+{
+  "data": [{
+    "id": 18048287,
+    "client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
+    "store_hash": "sftg45fsd",
+    "created_at": 1561488106,
+    "updated_at": 1561488106,
+    "scope": "store/order/*",
+    "destination": "https://665b65a6.ngrok.io/webhooks",
+    "is_active": true,
+    "headers": {
+      "custom": "string"
+    }
+  }],
+  "meta": {}
+}