Merge pull request #108 from jaredhendrickson13/fw_shaper_api

Firewall Shaper & Schedule Endpoints

Author: jaredhendrickson13

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: jaredhendrickson13

README.md

@@ -0,0 +1,38 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallSchedule extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/schedule";
+    }
+
+    protected function get() {
+        return (new APIFirewallScheduleRead())->call();
+    }
+
+    protected function post() {
+        return (new APIFirewallScheduleCreate())->call();
+    }
+
+    protected function put() {
+        return (new APIFirewallScheduleUpdate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallScheduleDelete())->call();
+    }
+}

docs/documentation.json

@@ -0,0 +1,30 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallScheduleTimeRange extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/schedule/time_range";
+    }
+
+    protected function post() {
+        return (new APIFirewallScheduleTimeRangeCreate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallScheduleTimeRangeDelete())->call();
+    }
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallSchedule.inc

@@ -0,0 +1,38 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallTrafficShaper extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/traffic_shaper";
+    }
+
+    protected function get() {
+        return (new APIFirewallTrafficShaperRead())->call();
+    }
+
+    protected function post() {
+        return (new APIFirewallTrafficShaperCreate())->call();
+    }
+
+    protected function put() {
+        return (new APIFirewallTrafficShaperUpdate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallTrafficShaperDelete())->call();
+    }
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallScheduleTimeRange.inc

@@ -0,0 +1,34 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallTrafficShaperLimiter extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/traffic_shaper/limiter";
+    }
+
+    protected function get() {
+        return (new APIFirewallTrafficShaperLimiterRead())->call();
+    }
+
+    protected function post() {
+        return (new APIFirewallTrafficShaperLimiterCreate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallTrafficShaperLimiterDelete())->call();
+    }
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaper.inc

@@ -0,0 +1,30 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallTrafficShaperLimiterBandwidth extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/traffic_shaper/limiter/bandwidth";
+    }
+
+    protected function post() {
+        return (new APIFirewallTrafficShaperLimiterBandwidthCreate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallTrafficShaperLimiterBandwidthDelete())->call();
+    }
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperLimiter.inc

@@ -0,0 +1,30 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallTrafficShaperLimiterQueue extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/traffic_shaper/limiter/queue";
+    }
+
+    protected function post() {
+        return (new APIFirewallTrafficShaperLimiterQueueCreate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallTrafficShaperLimiterQueueDelete())->call();
+    }
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperLimiterBandwidth.inc

@@ -0,0 +1,30 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallTrafficShaperQueue extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/traffic_shaper/queue";
+    }
+
+    protected function post() {
+        return (new APIFirewallTrafficShaperQueueCreate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallTrafficShaperQueueDelete())->call();
+    }
+}