opnsense_api 0.1.0

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

@@ -0,0 +1,27 @@
+module OPNsenseAPI
+  module Core
+    class Cron
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_job: (Hash[untyped, untyped] body) -> untyped
+
+        def del_job: (uuid: String) -> untyped
+
+        def get: () -> untyped
+
+        def get_job: (?uuid: String?) -> untyped
+
+        def search_jobs: (Hash[untyped, untyped] body) -> untyped
+
+        def set: (Hash[untyped, untyped] body) -> untyped
+
+        def set_job: (uuid: String, ?body: Hash[untyped, untyped]) -> untyped
+
+        def toggle_job: (uuid: String, ?enabled: untyped?) -> untyped
+      end
+    end
+  end
+end

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

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

data/sig/lib/opnsense_api/core/diagnostics/activity.rbs

@@ -0,0 +1,13 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Activity
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def get_activity: () -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/diagnostics/dns.rbs

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

data/sig/lib/opnsense_api/core/diagnostics/dns_diagnostics.rbs

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

data/sig/lib/opnsense_api/core/diagnostics/firewall.rbs

@@ -0,0 +1,33 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Firewall
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def del_state: (stateid: Integer, creatorid: Integer) -> untyped
+
+        def flush_sources: (?Hash[untyped, untyped] body) -> untyped
+
+        def flush_states: (?Hash[untyped, untyped] body) -> untyped
+
+        def kill_states: (?Hash[untyped, untyped] body) -> untyped
+
+        def list_rule_ids: (?Hash[untyped, untyped] params) -> untyped
+
+        def log: (?Hash[untyped, untyped] params) -> untyped
+
+        def log_filters: (?Hash[untyped, untyped] params) -> untyped
+
+        def pf_statistics: (?section: String?) -> untyped
+
+        def query_pf_top: (?Hash[untyped, untyped] body) -> untyped
+
+        def query_states: (?Hash[untyped, untyped] body) -> untyped
+
+        def stats: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/diagnostics/interface.rbs

@@ -0,0 +1,45 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Interface
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def carp_status: (status: String) -> untyped
+
+        def del_route: (?Hash[untyped, untyped] body) -> untyped
+
+        def flush_arp: (?Hash[untyped, untyped] body) -> untyped
+
+        def get_arp: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_bpf_statistics: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_interface_config: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_interface_names: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_memory_statistics: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_ndp: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_netisr_statistics: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_pf_sync_statistics: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_protocol_statistics: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_routes: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_socket_statistics: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_vip_status: (?Hash[untyped, untyped] params) -> untyped
+
+        def search_arp: (?Hash[untyped, untyped] params) -> untyped
+
+        def search_ndp: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/diagnostics/lv_template.rbs

@@ -0,0 +1,25 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class LVTemplate
+        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 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/diagnostics/netflow.rbs

@@ -0,0 +1,23 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Netflow
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def cache_stats: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_config: (?Hash[untyped, untyped] params) -> untyped
+
+        def is_enabled: (?Hash[untyped, untyped] params) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_config: (?Hash[untyped, untyped] params) -> untyped
+
+        def status: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/diagnostics/network_insight.rbs

@@ -0,0 +1,19 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class NetworkInsight
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def get_interfaces: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_metadata: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_protocols: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_services: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/diagnostics/packet_capture.rbs

@@ -0,0 +1,29 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class PacketCapture
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def download: (jobid: Integer) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def mac_info: (macaddr: String) -> untyped
+
+        def remove: (jobid: Integer) -> untyped
+
+        def search_jobs: (?Hash[untyped, untyped] params) -> untyped
+
+        def set: (?params: Hash[untyped, untyped], ?body: Hash[untyped, untyped]) -> untyped
+
+        def start: (jobid: Integer) -> untyped
+
+        def stop: (jobid: Integer) -> untyped
+
+        def view: (jobid: Integer, ?detail: String) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/diagnostics/system.rbs

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

data/sig/lib/opnsense_api/core/diagnostics/system_health.rbs

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class SystemHealth
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def get_interfaces: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_rrd_list: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/diagnostics/traffic.rbs

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Traffic
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def interface: (?Hash[untyped, untyped] params) -> untyped
+
+        def top: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      include OPNsenseAPI::Core
+
+      def activity: () -> Activity
+
+      def dns: () -> DNS
+
+      def dns_diagnostics: () -> DNSDiagnostics
+
+      def firewall: () -> Firewall
+
+      def interface: () -> Interface
+
+      def lv_template: () -> LVTemplate
+
+      def netflow: () -> Netflow
+
+      def network_insight: () -> NetworkInsight
+
+      def packet_capture: () -> PacketCapture
+
+      def system: () -> System
+
+      def system_health: () -> SystemHealth
+
+      def traffic: () -> Traffic
+    end
+  end
+end

data/sig/lib/opnsense_api/core/firewall/alias.rbs

@@ -0,0 +1,45 @@
+module OPNsenseAPI
+  module Core
+    class Firewall
+      class Alias
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_item: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_item: (uuid: String) -> untyped
+
+        def export: (?Hash[untyped, untyped] params) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_alias_uuid: (name: untyped) -> untyped
+
+        def get_geo_ip: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_item: (uuid: String) -> untyped
+
+        def get_table_size: (?Hash[untyped, untyped] params) -> untyped
+
+        def import: (?Hash[untyped, untyped] body) -> untyped
+
+        def list_categories: (?Hash[untyped, untyped] params) -> untyped
+
+        def list_countries: (?Hash[untyped, untyped] params) -> untyped
+
+        def list_network_aliases: (?Hash[untyped, untyped] params) -> 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
+
+        def toggle_item: (uuid: String, ?enabled: bool?) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/firewall/alias_util.rbs

@@ -0,0 +1,25 @@
+module OPNsenseAPI
+  module Core
+    class Firewall
+      class AliasUtil
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add: (id: String, ?body: Hash[untyped, untyped]) -> untyped
+
+        def aliases: (?Hash[untyped, untyped] params) -> untyped
+
+        def delete: (id: String) -> untyped
+
+        def find_references: (?Hash[untyped, untyped] body) -> untyped
+
+        def flush: (id: String, ?body: Hash[untyped, untyped]) -> untyped
+
+        def list: (id: String, ?params: Hash[untyped, untyped]) -> untyped
+
+        def update_bogons: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/firewall/category.rbs

@@ -0,0 +1,27 @@
+module OPNsenseAPI
+  module Core
+    class Firewall
+      class Category
+        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 search_item: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_no_category_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/firewall/filter_util.rbs

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

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

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class Firewall
+      include OPNsenseAPI::Core
+
+      def alias: () -> Alias
+
+      def alias_util: () -> AliasUtil
+
+      def category: () -> Category
+
+      def filter_util: () -> FilterUtil
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module OPNsenseAPI
+  module Core
+    class IDS
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def drop_alert_log: (?Hash[untyped, untyped] body) -> untyped
+
+        def get_alert_info: (alertid: String, ?fileid: String?) -> untyped
+
+        def get_alert_logs: (?Hash[untyped, untyped] params) -> untyped
+
+        def query_alerts: (?Hash[untyped, untyped] body) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def reload_rules: (?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
+
+        def update_rules: (?Hash[untyped, untyped] body, ?wait: String?) -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module OPNsenseAPI
+  module Core
+    class IDS
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_policy: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_policy_rule: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_user_rule: (?Hash[untyped, untyped] body) -> untyped
+
+        def check_policy_rule: (?Hash[untyped, untyped] params) -> untyped
+
+        def del_policy: (uuid: String) -> untyped
+
+        def del_policy_rule: (uuid: String) -> untyped
+
+        def del_user_rule: (uuid: String) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_policy: (?uuid: String?) -> untyped
+
+        def get_policy_rule: (?uuid: String?) -> untyped
+
+        def get_rule_info: (?sid: String?) -> untyped
+
+        def get_ruleset: (id: String) -> untyped
+
+        def get_ruleset_properties: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_user_rule: (?uuid: String?) -> untyped
+
+        def list_rule_metadata: (?Hash[untyped, untyped] params) -> untyped
+
+        def list_rulesets: (?Hash[untyped, untyped] params) -> untyped
+
+        def search_installed_rules: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_policy: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_policy_rule: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_user_rule: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_policy: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_policy_rule: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_rule: (?Hash[untyped, untyped] body, sid: String) -> untyped
+
+        def set_ruleset: (?Hash[untyped, untyped] body, filename: untyped) -> untyped
+
+        def set_ruleset_properties: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_user_rule: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def toggle_policy: (uuid: String, ?enabled: untyped?) -> untyped
+
+        def toggle_policy_rule: (uuid: String, ?enabled: untyped?) -> untyped
+
+        def toggle_rule: (sid: String, ?enabled: untyped?) -> untyped
+
+        def toggle_ruleset: (id: String, ?enabled: untyped?) -> untyped
+
+        def toggle_user_rule: (uuid: String, ?enabled: untyped?) -> untyped
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,25 @@
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      class Base
+        include OPNsenseAPI::Core
+
+        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/interfaces/loopback_settings.rbs

@@ -0,0 +1,9 @@
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      class LoopbackSettings < Base
+        BASE_PATH: String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      class VIPSettings < Base
+        BASE_PATH: String
+
+        def get_unused_vhid: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      class VLANSettings < Base
+        BASE_PATH: String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      class VXLANSettings < Base
+        BASE_PATH: String
+      end
+    end
+  end
+end