ninjaone 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b308dc5c61be46c792940ed58dc52596fa4146a1573e49db047396b1f959df61
-  data.tar.gz: 5cf673637b6af95d97ce82d81fd42970e47608aba6f018412b1d9c219f069c6a
+  metadata.gz: d2d9edce18fc48c11d1eee0a7d87d4e3d23f3622c54d522495181f50f2004bb3
+  data.tar.gz: a99415651e31f4616c478871acc3539abdcc16d452f372a366cdc321be9ed939
 SHA512:
-  metadata.gz: 07a6c00f22eaaebcf0053a140641f642c93d89cdf898626c08dd72f364a87e55a16266d690571be0a4252e3502265d94619a79c34f7da692b584cce6edb7e410
-  data.tar.gz: d0a45f7032e93a8581e8a49976fdc7e7e2928cf18f657dd707fedadef5352e0ca84dd48b21ed25d434d9737c3c7597d4acca35bcfb775ffd5782759b0b916b3a
+  metadata.gz: 13fe05ba9d907d7ebb217cdd79dd890e008a5805319e2de4bbcaba6a28d8f5a8f33cbed562f36797d081f823006553bbbdb4815a119a0678461b2b89bfaa5d5e
+  data.tar.gz: 4481305a4e29b2dc3e3043e05a383225790f0c745d10efcfbe5dc06368e34b5a3d0e7fed9c43c469dd27304276f6ed25f496cfafdce317c2b65c00ba36377bbb

data/CHANGELOG.md

@@ -4,3 +4,7 @@
 
 - Initial release
 
+## [0.2.0] - 2026-1-15
+
+- Added backup and devices api group
+

data/README.md

@@ -122,6 +122,44 @@ org_devices = client.organization_devices(org.id)
 |.organization_locations_backup_usage(id)|Organization location backup usage|
 |.organization_backup_usage_by_location(id, location_id)|Organization locations backup usage|
 
+### Backup
+
+All apis related to backup
+
+```ruby
+# get failed jobs using status filter
+failed_jobs = client.backup_jobs(sf:'status = FAILED')
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|`backup_jobs(params)`|Returns list of backup jobs. Params is a hash for filtering the result|
+|`backup_integrity_check_jobs(params)`|Returns a list of integrity check jobs|
+
+### Devices
+
+All apis related to devices.
+
+| Resource | API endpoint |
+|:--|:--|
+| `device(id, params = {})` | Retrieves the details of a single device by its device ID. |
+| `device_jobs(id, params = {})` | Retrieves all jobs associated with the specified device. |
+| `device_activities(id, params = {})` | Retrieves activities for the specified device (e.g. filtered using `since`). |
+| `device_alerts(id, params = {})` | Retrieves alerts related to the specified device. |
+| `device_disks(id, params = {})` | Retrieves disk information for the specified device. |
+| `device_processors(id, params = {})` | Retrieves processor information for the specified device. |
+| `device_software(id, params = {})` | Retrieves installed software for the specified device. |
+| `device_volumes(id, params = {})` | Retrieves volume information for the specified device. |
+| `device_windows_services(id, params = {})` | Retrieves Windows services for the specified device. |
+| `device_custom_fields(id, params = {})` | Retrieves custom fields associated with the specified device. |
+| `device_os_patch_installs(id, params = {})` | Retrieves operating system patch installation records for the specified device. |
+| `device_software_patch_installs(id, params = {})` | Retrieves software patch installation records for the specified device. |
+| `device_last_logged_on_user(id, params = {})` | Retrieves information about the last logged-on user of the device. |
+| `device_network_interfaces(id, params = {})` | Retrieves network interface information for the specified device. |
+| `device_os_patches(id, params = {})` | Retrieves available or installed operating system patches for the device. |
+| `device_software_patches(id, params = {})` | Retrieves available or installed software patches for the device. |
+| `device_policy_overrides(id, params = {})` | Retrieves policy overrides applied to the specified device. |
+
 
 ## Contributing
 

data/lib/ninjaone/client/backup.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NinjaOne
+  class Client
+    # Contains Backup-related API calls for Ninja One.
+    #
+    # @see https://app.ninjarmm.com/apidocs/?links.active=core#/Backup Ninja One Developer Documentation - Backup section
+    module Backup
+      # Dynamically defines methods for interacting with NinjaOne API resources.
+      #
+      # Depending on the arguments, this will define methods to:
+      # - Fetch all records for a resource
+      # - Fetch a specific record by ID
+      #
+      # @param method [Symbol] The method name for fetching all records.
+      # @param path [String] The API path for the resource. Defaults to the method name.
+      #
+      # @example Defining endpoints
+      #   api_endpoint :companies, :company
+      #   # Defines:
+      #   # - `companies(params = {})` to fetch all companies.
+      #   # - `company(id, params = {})` to fetch a single company by ID.
+      def self.backup_endpoint(method, path = method.to_s.tr('_', '-'))
+        # Define method to fetch all records
+        send(:define_method, method) do |params = {}|
+          results = get(api_url(path), params)
+          results.results
+        end
+      end
+
+      # Backup endpoints (GET)
+      backup_endpoint(:backup_jobs, 'backup/jobs')
+      backup_endpoint(:backup_integrity_check_jobs, 'backup/integrity-check-jobs')
+
+    end
+  end
+end

data/lib/ninjaone/client/devices.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module NinjaOne
+  class Client
+    # Contains Device-related API calls for Ninja One.
+    #
+    # @see https://app.ninjarmm.com/apidocs/?links.active=core#/Devices Ninja One Developer Documentation - Device section
+    module Devices
+      # Defines a device-specific API endpoint method dynamically.
+      #
+      # This helper creates instance methods in the form of:
+      #   device_<method>(id, params = {})
+      #
+      # Example:
+      #   device_endpoint(:jobs)
+      #   # => defines #device_jobs(id, params = {})
+      #
+      # @param method [Symbol]
+      #   The method name suffix to generate (e.g., :jobs, :alerts).
+      #
+      # @param path [String]
+      #   The API path segment. Defaults to the method name with
+      #   underscores replaced by hyphens.
+      #
+      # @return [void]
+      def self.device_endpoint(method, path = method.to_s.tr('_', '-'))
+        # Define method to fetch all records for device
+        send(:define_method, "device_#{method}") do |id, params = {}|
+          get(api_url("device/#{id}/#{path}"), params)
+        end
+      end
+
+      # Retrieves a single device by ID.
+      #
+      # @param id [Integer, String]
+      #   The NinjaOne device ID.
+      #
+      # @param params [Hash, nil]
+      #   Optional query parameters.
+      #
+      # @return [Hash]
+      #   The device details returned by the API.
+      def device(id, params = nil)
+        get(api_url("device/#{id}"), params)
+      end
+
+      # Device-related GET endpoints.
+      #
+      # Each symbol below dynamically generates a method:
+      #   device_<endpoint>(id, params = {})
+      #
+      # Example:
+      #   device_jobs(123)
+      #   device_activities(123, since: '2026-01-01T00:00:00Z')
+      #
+      [:jobs, :activities, :alerts, :disks, :processors, :software, :volumes, :windows_services, :custom_fields,
+       :os_patch_installs, :software_patch_installs, :last_logged_on_user, :network_interfaces, :os_patches, :software_patches].each do |m|
+        device_endpoint(m)
+      end
+      device_endpoint(:policy_overrides, 'policy/overrides')
+    end
+  end
+end

data/lib/ninjaone/client.rb

@@ -46,6 +46,8 @@ module NinjaOne
     # such as managing backups and handling alerts.
     include NinjaOne::Client::System
     include NinjaOne::Client::Organizations
+    include NinjaOne::Client::Backup
+    include NinjaOne::Client::Devices
 
     # Constructs the full API URL for a given path.
     #

data/lib/ninjaone/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NinjaOne
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ninjaone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Janco Tanis
 bindir: exe
 cert_chain: []
-date: 2025-12-10 00:00:00.000000000 Z
+date: 2026-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,6 +108,8 @@ files:
 - lib/ninjaone/api.rb
 - lib/ninjaone/authentication.rb
 - lib/ninjaone/client.rb
+- lib/ninjaone/client/backup.rb
+- lib/ninjaone/client/devices.rb
 - lib/ninjaone/client/organizations.rb
 - lib/ninjaone/client/system.rb
 - lib/ninjaone/error.rb