feat: add endpoints to allow querying child model objects #587

Author: jaredhendrickson13

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/FirewallTrafficShaperLimiterBandwidthsEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many TrafficShaperLimiterBandwidth Model objects at
+ * /api/v2/firewall/traffic_shaper/limiter/bandwidths.
+ */
+class FirewallTrafficShaperLimiterBandwidthsEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/firewall/traffic_shaper/limiter/bandwidths';
+        $this->model_name = 'TrafficShaperLimiterBandwidth';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/FirewallTrafficShaperLimiterQueuesEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many TrafficShaperLimiterQueue Model objects at
+ * /api/v2/firewall/traffic_shaper/limiter/queues.
+ */
+class FirewallTrafficShaperLimiterQueuesEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/firewall/traffic_shaper/limiter/queues';
+        $this->model_name = 'TrafficShaperLimiterQueue';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/FirewallTrafficShaperQueuesEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many TrafficShaperQueue Model objects at
+ * /api/v2/firewall/traffic_shaper/queues.
+ */
+class FirewallTrafficShaperQueuesEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/firewall/traffic_shaper/queues';
+        $this->model_name = 'TrafficShaperQueue';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/RoutingGatewayGroupPrioritiesEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many RoutingGatewayGroupPriority Model objects at
+ * /api/v2/routing/gateway/group/priorities.
+ */
+class RoutingGatewayGroupPrioritiesEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/routing/gateway/group/priorities';
+        $this->model_name = 'RoutingGatewayGroupPriority';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/ServicesBINDAccessListEntriesEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many BINDAccessListEntry Model objects at
+ * /api/v2/services/bind/access_list/entries.
+ */
+class ServicesBINDAccessListEntriesEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/services/bind/access_list/entries';
+        $this->model_name = 'BINDAccessListEntry';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/ServicesDHCPServerAddressPoolsEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with multiple DHCPServerAddressPool Model objects at
+ * /api/v2/services/dhcp_server/address_pools.
+ */
+class ServicesDHCPServerAddressPoolsEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/services/dhcp_server/address_pools';
+        $this->model_name = 'DHCPServerAddressPool';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/ServicesDHCPServerCustomOptionsEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with multiple DHCPServerCustomOption Model objects at
+ * /api/v2/services/dhcp_server/custom_options.
+ */
+class ServicesDHCPServerCustomOptionsEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/services/dhcp_server/custom_options';
+        $this->model_name = 'DHCPServerCustomOption';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/ServicesDHCPServerStaticMappingsEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many DHCPServerStaticMapping Model objects at
+ * /api/v2/services/dhcp_server/static_mappings.
+ */
+class ServicesDHCPServerStaticMappingsEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/services/dhcp_server/static_mappings';
+        $this->model_name = 'DHCPServerStaticMapping';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/ServicesDNSForwarderHostOverrideAliasesEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many DNSForwarderHostOverrideAlias Model objects at
+ * /api/v2/services/dns_forwarder/host_override/aliases.
+ */
+class ServicesDNSForwarderHostOverrideAliasesEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/services/dns_forwarder/host_override/aliases';
+        $this->model_name = 'DNSForwarderHostOverrideAlias';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/ServicesDNSResolverAccessListNetworksEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with many DNSResolverAccessListNetwork Model objects at
+ * /api/v2/services/dns_resolver/access_list/networks.
+ */
+class ServicesDNSResolverAccessListNetworksEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/services/dns_resolver/access_list/networks';
+        $this->model_name = 'DNSResolverAccessListNetwork';
+        $this->many = true;
+        $this->request_method_options = ['GET', 'DELETE'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}