opnsense_api 0.1.0

data/lib/opnsense_api/core/monit/settings.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Monit
+      # @see https://docs.opnsense.org/development/api/core/monit.html#id2
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/monit/settings'
+
+        def add_alert(body = {})
+          @client.post("#{BASE_PATH}/addAlert", body)
+        end
+
+        def add_service(body = {})
+          @client.post("#{BASE_PATH}/addService", body)
+        end
+
+        def add_test(body = {})
+          @client.post("#{BASE_PATH}/addTest", body)
+        end
+
+        def del_alert(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delAlert/#{uuid}", body)
+        end
+
+        def del_service(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delService/#{uuid}", body)
+        end
+
+        def del_test(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delTest/#{uuid}", body)
+        end
+
+        def dirty(params = {})
+          @client.get("#{BASE_PATH}/dirty", params)
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_alert(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getAlert/#{uuid}", params)
+        end
+
+        def get_general(params = {})
+          @client.get("#{BASE_PATH}/getGeneral", params)
+        end
+
+        def get_service(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getService/#{uuid}", params)
+        end
+
+        def get_test(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getTest/#{uuid}", params)
+        end
+
+        def search_alert(body = {})
+          @client.post("#{BASE_PATH}/searchAlert", body)
+        end
+
+        def search_service(body = {})
+          @client.post("#{BASE_PATH}/searchService", body)
+        end
+
+        def search_test(body = {})
+          @client.post("#{BASE_PATH}/searchTest", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_alert(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setAlert/#{uuid}", body)
+        end
+
+        def set_service(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setService/#{uuid}", body)
+        end
+
+        def set_test(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setTest/#{uuid}", body)
+        end
+
+        def toggle_alert(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleAlert/#{uuid}/#{enabled}", body)
+        end
+
+        def toggle_service(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleService/#{uuid}/#{enabled}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/monit/status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Monit
+      # @see https://docs.opnsense.org/development/api/core/monit.html#id3
+      class Status
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/monit/status'
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/monit.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/monit.html
+    class Monit
+      autoload :Service, 'opnsense_api/core/monit/service'
+      autoload :Settings, 'opnsense_api/core/monit/settings'
+      autoload :Status, 'opnsense_api/core/monit/status'
+
+      include OPNsenseAPI::Core
+
+      def service
+        Service.new(@client)
+      end
+
+      def settings
+        Settings.new(@client)
+      end
+
+      def status
+        Status.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/open_vpn/export.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class OpenVPN
+      # @see https://docs.opnsense.org/development/api/core/openvpn.html#id1
+      class Export
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/openvpn/export'
+
+        def accounts(params = {}, vpnid: nil)
+          @client.get("#{BASE_PATH}/accounts/#{vpnid}", params)
+        end
+
+        def download(body = {}, vpnid:, certref: nil)
+          @client.post("#{BASE_PATH}/download/#{vpnid}/#{certref}", body)
+        end
+
+        def providers(params = {})
+          @client.get("#{BASE_PATH}/providers", params)
+        end
+
+        def store_presets(body = {}, vpnid:)
+          @client.post("#{BASE_PATH}/storePresets/#{vpnid}", body)
+        end
+
+        def templates(params = {})
+          @client.get("#{BASE_PATH}/templates", params)
+        end
+
+        def validate_presets(body = {}, vpnid:)
+          @client.post("#{BASE_PATH}/validatePresets/#{vpnid}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/open_vpn.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/openvpn.html
+    class OpenVPN
+      autoload :Export, 'opnsense_api/core/open_vpn/export'
+
+      include OPNsenseAPI::Core
+
+      def export
+        Export.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/proxy/service.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Proxy
+      # @see https://docs.opnsense.org/development/api/core/proxy.html#id1
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/proxy/service'
+
+        def download_acls(body = {})
+          @client.post("#{BASE_PATH}/downloadacls", body)
+        end
+
+        def fetch_acls(body = {})
+          @client.post("#{BASE_PATH}/fetchacls", body)
+        end
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+
+        def refresh_template(body = {})
+          @client.post("#{BASE_PATH}/refreshTemplate", body)
+        end
+
+        def reset(body = {})
+          @client.post("#{BASE_PATH}/reset", body)
+        end
+
+        def restart(body = {})
+          @client.post("#{BASE_PATH}/restart", body)
+        end
+
+        def start(body = {})
+          @client.post("#{BASE_PATH}/start", body)
+        end
+
+        def status(body = {})
+          @client.post("#{BASE_PATH}/status", body)
+        end
+
+        def stop(body = {})
+          @client.post("#{BASE_PATH}/stop", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/proxy/settings.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Proxy
+      # @see https://docs.opnsense.org/development/api/core/proxy.html#id2
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/proxy/settings'
+
+        def add_pac_match(body = {})
+          @client.post("#{BASE_PATH}/addPACMatch", body)
+        end
+
+        def add_pac_proxy(body = {})
+          @client.post("#{BASE_PATH}/addPACProxy", body)
+        end
+
+        def add_pac_rule(body = {})
+          @client.post("#{BASE_PATH}/addPACRule", body)
+        end
+
+        def add_remote_blacklist(body = {})
+          @client.post("#{BASE_PATH}/addRemoteBlacklist", body)
+        end
+
+        def del_pac_match(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delPACMatch/#{uuid}", body)
+        end
+
+        def del_pac_proxy(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delPACProxy/#{uuid}", body)
+        end
+
+        def del_pac_rule(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delPACRule/#{uuid}", body)
+        end
+
+        def del_remote_blacklist(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delRemoteBlacklist/#{uuid}", body)
+        end
+
+        def fetch_rb_cron(body = {})
+          @client.post("#{BASE_PATH}/fetchRBCron", body)
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_pac_match(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getPACMatch/#{uuid}", params)
+        end
+
+        def get_pac_proxy(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getPACProxy/#{uuid}", params)
+        end
+
+        def get_pac_rule(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getPACRule/#{uuid}", params)
+        end
+
+        def get_remote_blacklist(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getRemoteBlacklist/#{uuid}", params)
+        end
+
+        def search_pac_match(body = {})
+          @client.post("#{BASE_PATH}/searchPACMatch", body)
+        end
+
+        def search_pac_proxy(body = {})
+          @client.post("#{BASE_PATH}/searchPACProxy", body)
+        end
+
+        def search_pac_rule(body = {})
+          @client.post("#{BASE_PATH}/searchPACRule", body)
+        end
+
+        def search_remote_blacklists(body = {})
+          @client.post("#{BASE_PATH}/searchRemoteBlacklists", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_pac_match(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setPACMatch/#{uuid}", body)
+        end
+
+        def set_pac_proxy(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setPACProxy/#{uuid}", body)
+        end
+
+        def set_pac_rule(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setPACRule/#{uuid}", body)
+        end
+
+        def set_remote_blacklist(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setRemoteBlacklist/#{uuid}", body)
+        end
+
+        def toggle_pac_rule(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/togglePACRule/#{uuid}", body)
+        end
+
+        def toggle_remote_blacklist(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/toggleRemoteBlacklist/#{uuid}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/proxy/template.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Proxy
+      # @see https://docs.opnsense.org/development/api/core/proxy.html#id3
+      class Template
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/proxy/template'
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def reset(body = {})
+          @client.post("#{BASE_PATH}/reset", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/proxy.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/proxy.html
+    class Proxy
+      autoload :Service, 'opnsense_api/core/proxy/service'
+      autoload :Settings, 'opnsense_api/core/proxy/settings'
+      autoload :Template, 'opnsense_api/core/proxy/template'
+
+      include OPNsenseAPI::Core
+
+      def service
+        Service.new(@client)
+      end
+
+      def settings
+        Settings.new(@client)
+      end
+
+      def template
+        Template.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/routes/gateway.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Routes
+      # @see https://docs.opnsense.org/development/api/core/routes.html#id1
+      class Gateway
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/routes/gateway'
+
+        def status(params = {})
+          @client.get("#{BASE_PATH}/status", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/routes/routes.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Routes
+      # @see https://docs.opnsense.org/development/api/core/routes.html#id2
+      class Routes
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/routes/routes'
+
+        def add_route(body = {})
+          @client.post("#{BASE_PATH}/addroute", body)
+        end
+
+        def del_route(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delroute/#{uuid}", body)
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_route(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getroute/#{uuid}", params)
+        end
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+
+        def search_route(body = {})
+          @client.post("#{BASE_PATH}/searchroute", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_route(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setroute/#{uuid}", body)
+        end
+
+        def toggle_route(body = {}, uuid:, disabled: nil)
+          @client.post("#{BASE_PATH}/toggleRoute/#{uuid}/#{disabled}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/routes.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/routes.html
+    class Routes
+      autoload :Gateway, 'opnsense_api/core/routes/gateway'
+      autoload :Routes, 'opnsense_api/core/routes/routes'
+
+      include OPNsenseAPI::Core
+
+      def gateway
+        Gateway.new(@client)
+      end
+
+      def routes
+        Routes.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/syslog/service.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Syslog
+      # @see https://docs.opnsense.org/development/api/core/syslog.html#id1
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/syslog/service'
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+
+        def restart(body = {})
+          @client.post("#{BASE_PATH}/restart", body)
+        end
+
+        def start(body = {})
+          @client.post("#{BASE_PATH}/start", body)
+        end
+
+        def stats(params = {})
+          @client.get("#{BASE_PATH}/stats", params)
+        end
+
+        def status(params = {})
+          @client.get("#{BASE_PATH}/status", params)
+        end
+
+        def stop(body = {})
+          @client.post("#{BASE_PATH}/stop", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/syslog/settings.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Syslog
+      # @see https://docs.opnsense.org/development/api/core/syslog.html#id2
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/syslog/settings'
+
+        def add_destination(body = {})
+          @client.post("#{BASE_PATH}/addDestination", body)
+        end
+
+        def del_destination(body = {})
+          @client.post("#{BASE_PATH}/delDestination", body)
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_destination(params = {})
+          @client.get("#{BASE_PATH}/getDestination", params)
+        end
+
+        def search_destination(body = {})
+          @client.post("#{BASE_PATH}/searchDestination", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_destination(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setDestination/#{uuid}", body)
+        end
+
+        def toggle_destination(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleDestination/#{uuid}/#{enabled}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/syslog.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/syslog.html
+    class Syslog
+      autoload :Service, 'opnsense_api/core/syslog/service'
+      autoload :Settings, 'opnsense_api/core/syslog/settings'
+
+      include OPNsenseAPI::Core
+
+      def service
+        Service.new(@client)
+      end
+
+      def settings
+        Settings.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/traffic_shaping/service.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class TrafficShaping
+      # @see https://docs.opnsense.org/development/api/core/trafficshaper.html#id1
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/trafficshaper/service'
+
+        def flush_reload(body = {})
+          @client.post("#{BASE_PATH}/flushReload", body)
+        end
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+
+        def statistics(params = {})
+          @client.get("#{BASE_PATH}/statistics", params)
+        end
+      end
+    end
+  end
+end