opnsense_api 0.1.0

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

@@ -0,0 +1,51 @@
+module OPNsenseAPI
+  module Core
+    class TrafficShaping
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_pipe: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_queue: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_rule: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_pipe: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_queue: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_rule: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_pipe: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_queue: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_rule: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def search_pipes: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_queues: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_rules: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_pipe: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_queue: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_rule: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def toggle_pipe: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+
+        def toggle_queue: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+
+        def toggle_rule: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+module OPNsenseAPI
+  module Core
+    class Unbound
+      class Diagnostics
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def dump_cache: (?Hash[untyped, untyped] params) -> untyped
+
+        def dump_infra: (?Hash[untyped, untyped] params) -> untyped
+
+        def list_insecure: (?Hash[untyped, untyped] params) -> untyped
+
+        def list_local_data: (?Hash[untyped, untyped] params) -> untyped
+
+        def list_local_zones: (?Hash[untyped, untyped] params) -> untyped
+
+        def stats: (?Hash[untyped, untyped] params) -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module OPNsenseAPI
+  module Core
+    class Unbound
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def dnsbl: (?Hash[untyped, untyped] params) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] params) -> 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/unbound/settings.rbs

@@ -0,0 +1,65 @@
+module OPNsenseAPI
+  module Core
+    class Unbound
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_domain_override: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_forward: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_host_alias: (?Hash[untyped, untyped] body) -> untyped
+
+        def add_host_override: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_domain_override: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_forward: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_host_alias: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def del_host_override: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def get: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_domain_override: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_forward: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_host_alias: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_host_override: (?Hash[untyped, untyped] params, ?uuid: String?) -> untyped
+
+        def get_nameservers: (?Hash[untyped, untyped] params) -> untyped
+
+        def search_domain_override: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_forward: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_host_alias: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_host_override: (?Hash[untyped, untyped] body) -> untyped
+
+        def set: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_domain_override: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_forward: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_host_alias: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def set_host_override: (?Hash[untyped, untyped] body, uuid: String) -> untyped
+
+        def toggle_domain_override: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+
+        def toggle_forward: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+
+        def toggle_host_alias: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+
+        def toggle_host_override: (?Hash[untyped, untyped] body, uuid: String, ?enabled: bool?) -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module OPNsenseAPI
+  module Core
+    class Unbound
+      include OPNsenseAPI::Core
+
+      def diagnostics: () -> Diagnostics
+
+      def service: () -> Service
+
+      def settings: () -> Settings
+    end
+  end
+end

data/sig/lib/opnsense_api/core.rbs

@@ -0,0 +1,7 @@
+module OPNsenseAPI
+  module Core
+    @client: Client
+
+    def initialize: (Client client) -> void
+  end
+end

data/sig/lib/opnsense_api/version.rbs

@@ -0,0 +1,3 @@
+module OPNsenseAPI
+  VERSION: String
+end

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification
+name: opnsense_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zach Bensley
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description:
+email:
+- zach@bensley.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/opnsense_api.rb
+- lib/opnsense_api/client.rb
+- lib/opnsense_api/core.rb
+- lib/opnsense_api/core/captive_portal.rb
+- lib/opnsense_api/core/captive_portal/access.rb
+- lib/opnsense_api/core/captive_portal/service.rb
+- lib/opnsense_api/core/captive_portal/session.rb
+- lib/opnsense_api/core/captive_portal/settings.rb
+- lib/opnsense_api/core/captive_portal/voucher.rb
+- lib/opnsense_api/core/core.rb
+- lib/opnsense_api/core/core/firmware.rb
+- lib/opnsense_api/core/core/menu.rb
+- lib/opnsense_api/core/core/system.rb
+- lib/opnsense_api/core/cron.rb
+- lib/opnsense_api/core/cron/service.rb
+- lib/opnsense_api/core/cron/settings.rb
+- lib/opnsense_api/core/diagnostics.rb
+- lib/opnsense_api/core/diagnostics/activity.rb
+- lib/opnsense_api/core/diagnostics/dns.rb
+- lib/opnsense_api/core/diagnostics/dns_diagnostics.rb
+- lib/opnsense_api/core/diagnostics/firewall.rb
+- lib/opnsense_api/core/diagnostics/interface.rb
+- lib/opnsense_api/core/diagnostics/lv_template.rb
+- lib/opnsense_api/core/diagnostics/netflow.rb
+- lib/opnsense_api/core/diagnostics/network_insight.rb
+- lib/opnsense_api/core/diagnostics/packet_capture.rb
+- lib/opnsense_api/core/diagnostics/system.rb
+- lib/opnsense_api/core/diagnostics/system_health.rb
+- lib/opnsense_api/core/diagnostics/traffic.rb
+- lib/opnsense_api/core/firewall.rb
+- lib/opnsense_api/core/firewall/alias.rb
+- lib/opnsense_api/core/firewall/alias_util.rb
+- lib/opnsense_api/core/firewall/category.rb
+- lib/opnsense_api/core/firewall/filter_util.rb
+- lib/opnsense_api/core/ids.rb
+- lib/opnsense_api/core/ids/service.rb
+- lib/opnsense_api/core/ids/settings.rb
+- lib/opnsense_api/core/interfaces.rb
+- lib/opnsense_api/core/interfaces/base.rb
+- lib/opnsense_api/core/interfaces/loopback_settings.rb
+- lib/opnsense_api/core/interfaces/vip_settings.rb
+- lib/opnsense_api/core/interfaces/vlan_settings.rb
+- lib/opnsense_api/core/interfaces/vxlan_settings.rb
+- lib/opnsense_api/core/ipsec.rb
+- lib/opnsense_api/core/ipsec/key_pairs.rb
+- lib/opnsense_api/core/ipsec/leases.rb
+- lib/opnsense_api/core/ipsec/legacy_subsystem.rb
+- lib/opnsense_api/core/ipsec/pre_shared_keys.rb
+- lib/opnsense_api/core/ipsec/sad.rb
+- lib/opnsense_api/core/ipsec/service.rb
+- lib/opnsense_api/core/ipsec/sessions.rb
+- lib/opnsense_api/core/ipsec/spd.rb
+- lib/opnsense_api/core/ipsec/tunnel.rb
+- lib/opnsense_api/core/monit.rb
+- lib/opnsense_api/core/monit/service.rb
+- lib/opnsense_api/core/monit/settings.rb
+- lib/opnsense_api/core/monit/status.rb
+- lib/opnsense_api/core/open_vpn.rb
+- lib/opnsense_api/core/open_vpn/export.rb
+- lib/opnsense_api/core/proxy.rb
+- lib/opnsense_api/core/proxy/service.rb
+- lib/opnsense_api/core/proxy/settings.rb
+- lib/opnsense_api/core/proxy/template.rb
+- lib/opnsense_api/core/routes.rb
+- lib/opnsense_api/core/routes/gateway.rb
+- lib/opnsense_api/core/routes/routes.rb
+- lib/opnsense_api/core/syslog.rb
+- lib/opnsense_api/core/syslog/service.rb
+- lib/opnsense_api/core/syslog/settings.rb
+- lib/opnsense_api/core/traffic_shaping.rb
+- lib/opnsense_api/core/traffic_shaping/service.rb
+- lib/opnsense_api/core/traffic_shaping/settings.rb
+- lib/opnsense_api/core/unbound.rb
+- lib/opnsense_api/core/unbound/diagnostics.rb
+- lib/opnsense_api/core/unbound/service.rb
+- lib/opnsense_api/core/unbound/settings.rb
+- lib/opnsense_api/error.rb
+- lib/opnsense_api/version.rb
+- sig/lib/opnsense_api/client.rbs
+- sig/lib/opnsense_api/core.rbs
+- sig/lib/opnsense_api/core/captive_portal.rbs
+- sig/lib/opnsense_api/core/captive_portal/access.rbs
+- sig/lib/opnsense_api/core/captive_portal/service.rbs
+- sig/lib/opnsense_api/core/captive_portal/session.rbs
+- sig/lib/opnsense_api/core/captive_portal/settings.rbs
+- sig/lib/opnsense_api/core/captive_portal/voucher.rbs
+- sig/lib/opnsense_api/core/core.rbs
+- sig/lib/opnsense_api/core/core/firmware.rbs
+- sig/lib/opnsense_api/core/core/menu.rbs
+- sig/lib/opnsense_api/core/core/system.rbs
+- sig/lib/opnsense_api/core/cron.rbs
+- sig/lib/opnsense_api/core/cron/service.rbs
+- sig/lib/opnsense_api/core/cron/settings.rbs
+- sig/lib/opnsense_api/core/diagnostics.rbs
+- sig/lib/opnsense_api/core/diagnostics/activity.rbs
+- sig/lib/opnsense_api/core/diagnostics/dns.rbs
+- sig/lib/opnsense_api/core/diagnostics/dns_diagnostics.rbs
+- sig/lib/opnsense_api/core/diagnostics/firewall.rbs
+- sig/lib/opnsense_api/core/diagnostics/interface.rbs
+- sig/lib/opnsense_api/core/diagnostics/lv_template.rbs
+- sig/lib/opnsense_api/core/diagnostics/netflow.rbs
+- sig/lib/opnsense_api/core/diagnostics/network_insight.rbs
+- sig/lib/opnsense_api/core/diagnostics/packet_capture.rbs
+- sig/lib/opnsense_api/core/diagnostics/system.rbs
+- sig/lib/opnsense_api/core/diagnostics/system_health.rbs
+- sig/lib/opnsense_api/core/diagnostics/traffic.rbs
+- sig/lib/opnsense_api/core/firewall.rbs
+- sig/lib/opnsense_api/core/firewall/alias.rbs
+- sig/lib/opnsense_api/core/firewall/alias_util.rbs
+- sig/lib/opnsense_api/core/firewall/category.rbs
+- sig/lib/opnsense_api/core/firewall/filter_util.rbs
+- sig/lib/opnsense_api/core/ids.rbs
+- sig/lib/opnsense_api/core/ids/service.rbs
+- sig/lib/opnsense_api/core/ids/settings.rbs
+- sig/lib/opnsense_api/core/interfaces.rbs
+- sig/lib/opnsense_api/core/interfaces/base.rbs
+- sig/lib/opnsense_api/core/interfaces/loopback_settings.rbs
+- sig/lib/opnsense_api/core/interfaces/vip_settings.rbs
+- sig/lib/opnsense_api/core/interfaces/vlan_settings.rbs
+- sig/lib/opnsense_api/core/interfaces/vxlan_settings.rbs
+- sig/lib/opnsense_api/core/ipsec.rbs
+- sig/lib/opnsense_api/core/ipsec/key_pairs.rbs
+- sig/lib/opnsense_api/core/ipsec/leases.rbs
+- sig/lib/opnsense_api/core/ipsec/legacy_subsystem.rbs
+- sig/lib/opnsense_api/core/ipsec/pre_shared_keys.rbs
+- sig/lib/opnsense_api/core/ipsec/sad.rbs
+- sig/lib/opnsense_api/core/ipsec/service.rbs
+- sig/lib/opnsense_api/core/ipsec/sessions.rbs
+- sig/lib/opnsense_api/core/ipsec/spd.rbs
+- sig/lib/opnsense_api/core/ipsec/tunnel.rbs
+- sig/lib/opnsense_api/core/monit.rbs
+- sig/lib/opnsense_api/core/monit/service.rbs
+- sig/lib/opnsense_api/core/monit/settings.rbs
+- sig/lib/opnsense_api/core/monit/status.rbs
+- sig/lib/opnsense_api/core/open_vpn.rbs
+- sig/lib/opnsense_api/core/open_vpn/export.rbs
+- sig/lib/opnsense_api/core/proxy.rbs
+- sig/lib/opnsense_api/core/proxy/service.rbs
+- sig/lib/opnsense_api/core/proxy/settings.rbs
+- sig/lib/opnsense_api/core/proxy/template.rbs
+- sig/lib/opnsense_api/core/routes.rbs
+- sig/lib/opnsense_api/core/routes/gateway.rbs
+- sig/lib/opnsense_api/core/routes/routes.rbs
+- sig/lib/opnsense_api/core/syslog.rbs
+- sig/lib/opnsense_api/core/syslog/service.rbs
+- sig/lib/opnsense_api/core/syslog/settings.rbs
+- sig/lib/opnsense_api/core/traffic_shaping.rbs
+- sig/lib/opnsense_api/core/traffic_shaping/service.rbs
+- sig/lib/opnsense_api/core/traffic_shaping/settings.rbs
+- sig/lib/opnsense_api/core/unbound.rbs
+- sig/lib/opnsense_api/core/unbound/diagnostics.rbs
+- sig/lib/opnsense_api/core/unbound/service.rbs
+- sig/lib/opnsense_api/core/unbound/settings.rbs
+- sig/lib/opnsense_api/version.rbs
+homepage: https://github.com/zaben903/opnsense_api
+licenses:
+- LGPL-3.0-or-later
+metadata:
+  homepage_uri: https://github.com/zaben903/opnsense_api
+  source_code_uri: https://github.com/zaben903/opnsense_api
+  changelog_uri: https://github.com/zaben903/opnsense_api/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Library for using the OPNsense API
+test_files: []