opnsense_api 0.1.0

data/sig/lib/opnsense_api/core/interfaces.rbs

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      include OPNsenseAPI::Core
+
+      def loopback_settings: () -> LoopbackSettings
+
+      def vip_settings: () -> VIPSettings
+
+      def vlan_settings: () -> VLANSettings
+
+      def vxlan_settings: () -> VXLANSettings
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/key_pairs.rbs

@@ -0,0 +1,27 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class KeyPairs
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_item: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_item: (uuid: String) -> untyped
+
+        def get_key_pair: (type: String, ?size: Integer?) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_item: (?uuid: String?) -> untyped
+
+        def search_item: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_item: (uuid: String, ?body: Hash[untyped, untyped]) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/leases.rbs

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class Leases
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def pools: (?Hash[untyped, untyped] params) -> untyped
+
+        def search: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/legacy_subsystem.rbs

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class LegacySubsystem
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def apply_config: (?Hash[untyped, untyped] body) -> untyped
+
+        def status: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/pre_shared_keys.rbs

@@ -0,0 +1,27 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class PreSharedKeys
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_item: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_item: (uuid: String) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_item: (?uuid: String?) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_item: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_item: (uuid: String, ?body: Hash[untyped, untyped]) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/sad.rbs

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class SAD
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def delete: (?Hash[untyped, untyped] body, id: String) -> untyped
+
+        def search: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/service.rbs

@@ -0,0 +1,21 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def restart: (?Hash[untyped, untyped] body) -> untyped
+
+        def start: (?Hash[untyped, untyped] body) -> untyped
+
+        def status: (?Hash[untyped, untyped] params) -> untyped
+
+        def stop: (?Hash[untyped, untyped] body) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/sessions.rbs

@@ -0,0 +1,19 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class Sessions
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def connect: (?Hash[untyped, untyped] body, id: String) -> untyped
+
+        def disconnect: (?Hash[untyped, untyped] body, id: String) -> untyped
+
+        def search_phase_1: (?Hash[untyped, untyped] params) -> untyped
+
+        def search_phase_2: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/spd.rbs

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class SPD
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def delete: (?Hash[untyped, untyped] body, id: String) -> untyped
+
+        def search: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec/tunnel.rbs

@@ -0,0 +1,25 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      class Tunnel
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def del_phase_1: (?Hash[untyped, untyped] body, ikeid: String) -> untyped
+
+        def del_phase_2: (?Hash[untyped, untyped] body, seqid: String) -> untyped
+
+        def search_phase_1: (?Hash[untyped, untyped] params) -> untyped
+
+        def search_phase_2: (?Hash[untyped, untyped] params) -> untyped
+
+        def toggle: (?Hash[untyped, untyped] body, ?enabled: String?) -> untyped
+
+        def toggle_phase_1: (?Hash[untyped, untyped] body, ikeid: String, ?enabled: String?) -> untyped
+
+        def toggle_phase_2: (?Hash[untyped, untyped] body, seqid: String, ?enabled: String?) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/ipsec.rbs

@@ -0,0 +1,25 @@
+module OPNsenseAPI
+  module Core
+    class IPSec
+      include OPNsenseAPI::Core
+
+      def key_pairs: () -> KeyPairs
+
+      def leases: () -> Leases
+
+      def legacy_subsystem: () -> LegacySubsystem
+
+      def pre_shared_keys: () -> PreSharedKeys
+
+      def sad: () -> SAD
+
+      def service: () -> Service
+
+      def sessions: () -> Sessions
+
+      def spd: () -> SPD
+
+      def tunnel: () -> Tunnel
+    end
+  end
+end

data/sig/lib/opnsense_api/core/monit/service.rbs

@@ -0,0 +1,23 @@
+module OPNsenseAPI
+  module Core
+    class Monit
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def check: (?Hash[untyped, untyped] body) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def restart: (?Hash[untyped, untyped] body) -> untyped
+
+        def start: (?Hash[untyped, untyped] body) -> untyped
+
+        def status: (?Hash[untyped, untyped] params) -> untyped
+
+        def stop: (?Hash[untyped, untyped] body) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/monit/settings.rbs

@@ -0,0 +1,53 @@
+module OPNsenseAPI
+  module Core
+    class Monit
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_alert: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_service: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_test: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_alert: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_service: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_test: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def dirty: (?Hash[untyped, untyped] params) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_alert: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_general: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_service: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_test: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def search_alert: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_service: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_test: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_alert: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_service: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_test: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def toggle_alert: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+
+        def toggle_service: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/monit/status.rbs

@@ -0,0 +1,13 @@
+module OPNsenseAPI
+  module Core
+    class Monit
+      class Status
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/monit.rbs

@@ -0,0 +1,13 @@
+module OPNsenseAPI
+  module Core
+    class Monit
+      include OPNsenseAPI::Core
+
+      def service: () -> Service
+
+      def settings: () -> Settings
+
+      def status: () -> Status
+    end
+  end
+end

data/sig/lib/opnsense_api/core/open_vpn/export.rbs

@@ -0,0 +1,23 @@
+module OPNsenseAPI
+  module Core
+    class OpenVPN
+      class Export
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def accounts: (?Hash[untyped, untyped] params, ?vpnid: String?) -> untyped
+
+        def download: (?Hash[untyped, untyped] body, vpnid: String, ?certref: String?) -> untyped
+
+        def providers: (?Hash[untyped, untyped] params) -> untyped
+
+        def store_presets: (?Hash[untyped, untyped] body, vpnid: String) -> untyped
+
+        def templates: (?Hash[untyped, untyped] params) -> untyped
+
+        def validate_presets: (?Hash[untyped, untyped] body, vpnid: String) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/open_vpn.rbs

@@ -0,0 +1,9 @@
+module OPNsenseAPI
+  module Core
+    class OpenVPN
+      include OPNsenseAPI::Core
+
+      def export: () -> Export
+    end
+  end
+end

data/sig/lib/opnsense_api/core/proxy/service.rbs

@@ -0,0 +1,29 @@
+module OPNsenseAPI
+  module Core
+    class Proxy
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def download_acls: (?Hash[untyped, untyped] body) -> untyped
+
+        def fetch_acls: (?Hash[untyped, untyped] body) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def refresh_template: (?Hash[untyped, untyped] body) -> untyped
+
+        def reset: (?Hash[untyped, untyped] body) -> untyped
+
+        def restart: (?Hash[untyped, untyped] body) -> untyped
+
+        def start: (?Hash[untyped, untyped] body) -> untyped
+
+        def status: (?Hash[untyped, untyped] body) -> untyped
+
+        def stop: (?Hash[untyped, untyped] body) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/proxy/settings.rbs

@@ -0,0 +1,61 @@
+module OPNsenseAPI
+  module Core
+    class Proxy
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_pac_match: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_pac_proxy: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_pac_rule: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_remote_blacklist: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_pac_match: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_pac_proxy: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_pac_rule: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_remote_blacklist: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def fetch_rb_cron: (?Hash[untyped, untyped] body) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_pac_match: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_pac_proxy: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_pac_rule: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_remote_blacklist: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def search_pac_match: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_pac_proxy: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_pac_rule: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_remote_blacklists: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_pac_match: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_pac_proxy: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_pac_rule: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_remote_blacklist: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def toggle_pac_rule: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def toggle_remote_blacklist: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/proxy/template.rbs

@@ -0,0 +1,17 @@
+module OPNsenseAPI
+  module Core
+    class Proxy
+      class Template
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def reset: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/proxy.rbs

@@ -0,0 +1,13 @@
+module OPNsenseAPI
+  module Core
+    class Proxy
+      include OPNsenseAPI::Core
+
+      def service: () -> Service
+
+      def settings: () -> Settings
+
+      def template: () -> Template
+    end
+  end
+end

data/sig/lib/opnsense_api/core/routes/gateway.rbs

@@ -0,0 +1,13 @@
+module OPNsenseAPI
+  module Core
+    class Routes
+      class Gateway
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def status: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/routes/routes.rbs

@@ -0,0 +1,29 @@
+module OPNsenseAPI
+  module Core
+    class Routes
+      class Routes
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_route: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_route: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_route: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_route: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_route: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def toggle_route: (?Hash[untyped, untyped] body, uuid: String, ?disabled: bool?) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/routes.rbs

@@ -0,0 +1,11 @@
+module OPNsenseAPI
+  module Core
+    class Routes
+      include OPNsenseAPI::Core
+
+      def gateway: () -> Gateway
+
+      def routes: () -> Routes
+    end
+  end
+end

data/sig/lib/opnsense_api/core/syslog/service.rbs

@@ -0,0 +1,23 @@
+module OPNsenseAPI
+  module Core
+    class Syslog
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def restart: (?Hash[untyped, untyped] body) -> untyped
+
+        def start: (?Hash[untyped, untyped] body) -> untyped
+
+        def stats: (?Hash[untyped, untyped] params) -> untyped
+
+        def status: (?Hash[untyped, untyped] params) -> untyped
+
+        def stop: (?Hash[untyped, untyped] body) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/syslog/settings.rbs

@@ -0,0 +1,27 @@
+module OPNsenseAPI
+  module Core
+    class Syslog
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_destination: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_destination: (?Hash[untyped, untyped] body) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_destination: (?Hash[untyped, untyped] params) -> untyped
+
+        def search_destination: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_destination: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def toggle_destination: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/syslog.rbs

@@ -0,0 +1,11 @@
+module OPNsenseAPI
+  module Core
+    class Syslog
+      include OPNsenseAPI::Core
+
+      def service: () -> Service
+
+      def settings: () -> Settings
+    end
+  end
+end

data/sig/lib/opnsense_api/core/traffic_shaping/service.rbs

@@ -0,0 +1,17 @@
+module OPNsenseAPI
+  module Core
+    class TrafficShaping
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def flush_reload: (?Hash[untyped, untyped] body) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def statistics: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end