ruby-jss 4.1.1 → 4.2.0b2

data/lib/jamf/api/classic/api_objects/mobile_device_application.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -177,6 +177,9 @@ module Jamf
     #   take over managing it?
     attr_reader :take_over_management
 
+    # @return [Boolean] Can a user delete this app once it's installed?
+    attr_reader :allow_user_to_delete
+
     # @return [Boolean] Does the app itself come from outside the JSS?
     attr_reader :host_externally
 
@@ -216,6 +219,7 @@ module Jamf
       @keep_description_and_icon_up_to_date = general[:keep_description_and_icon_up_to_date]
       @free = general[:free]
       @take_over_management = general[:take_over_management]
+      @allow_user_to_delete = general[:allow_user_to_delete]
       @host_externally = general[:host_externally]
       @external_url = general[:external_url]
       @configuration_prefs = @init_data[:app_configuration][:preferences]
@@ -400,6 +404,20 @@ module Jamf
       @need_to_update = true
     end
 
+    # Set whether or not the user should be able to delete this app
+    #
+    # @param new_val[Boolean] The new value
+    #
+    # @return [void]
+    #
+    def allow_user_to_delete=(new_val)
+      return nil if new_val == @allow_user_to_delete
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
+      @allow_user_to_delete = new_val
+      @need_to_update = true
+    end
+
     # Sets the version (only usable if you are hosting the .ipa externally)
     #
     # @param new_val[String] the version
@@ -557,12 +575,15 @@ module Jamf
       gen.add_element('keep_description_and_icon_up_to_date').text = @keep_description_and_icon_up_to_date
       gen.add_element('free').text = @free
       gen.add_element('take_over_management').text = @take_over_management
+      gen.add_element('allow_user_to_delete').text = @allow_user_to_delete
       gen.add_element('host_externally').text = @host_externally
       gen.add_element('bundle_id').text = @bundle_id if @host_externally
       gen.add_element('version').text = @version if @host_externally
       gen.add_element('external_url').text = @external_url
-      config = gen.add_element('configuration')
+
+      config = obj.add_element('app_configuration')
       config.add_element('preferences').text = @configuration_prefs
+
       obj << @scope.scope_xml
       add_category_to_xml doc
       add_self_service_xml doc

data/lib/jamf/api/classic/api_objects/mobile_device_configuration_profile.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/classic/api_objects/mobile_device_extension_attribute.rb

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -25,7 +25,6 @@ module Jamf
   # Classes
   #####################################
 
-
   # An extension attribute as defined in the JSS
   #
   # @see Jamf::ExtensionAttribute
@@ -51,7 +50,8 @@ module Jamf
     TARGET_CLASS = Jamf::MobileDevice
 
     # A criterion that will return all members of the TARGET_CLASS
-    ALL_TARGETS_CRITERION = Jamf::Criteriable::Criterion.new(and_or: 'and', name: 'Last Inventory Update', search_type: 'after (yyyy-mm-dd)', value: '2003-01-01')
+    ALL_TARGETS_CRITERION = Jamf::Criteriable::Criterion.new(and_or: 'and', name: 'Last Inventory Update', search_type: 'after (yyyy-mm-dd)', 
+                                                             value: '2003-01-01')
 
     # the object type for this object in
     # the object history table.

data/lib/jamf/api/classic/api_objects/mobile_device_group.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -63,7 +63,7 @@ module Jamf
     #####################################
 
     ### The base for REST resources of this class
-    RSRC_BASE = "mobiledevicegroups"
+    RSRC_BASE = 'mobiledevicegroups'
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :mobile_device_groups
@@ -111,7 +111,7 @@ module Jamf
     ### @return [Array<String>] the member udids
     ###
     def member_udids
-      @members.map{|m| m[:udid]}
+      @members.map { |m| m[:udid] }
     end
 
     ###
@@ -120,7 +120,7 @@ module Jamf
     ### @return [Array<String>] the member serial numbers
     ###
     def member_serial_numbers
-      @members.map{|m| m[:serial_number]}
+      @members.map { |m| m[:serial_number] }
     end
 
     ###
@@ -129,7 +129,7 @@ module Jamf
     ### @return [Array<String>] the member mac addresses
     ###
     def member_mac_addresses
-      @members.map{|m| m[:mac_address]}
+      @members.map { |m| m[:mac_address] }
     end
 
     ###
@@ -138,14 +138,13 @@ module Jamf
     ### @return [Array<String>] the member wifi mac addresses
     ###
     def member_wifi_mac_addresses
-      @members.map{|m| m[:wifi_mac_address]}
+      @members.map { |m| m[:wifi_mac_address] }
     end
 
     #####################################
     ### Private Instance Methods
     #####################################
 
-
   end # class ComputerGroup
 
 end # module

data/lib/jamf/api/classic/api_objects/netboot_server.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -61,7 +61,7 @@ module Jamf
     #####################################
 
     ### The base for REST resources of this class
-    RSRC_BASE = "netbootservers"
+    RSRC_BASE = 'netbootservers'
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :netboot_servers
@@ -115,7 +115,6 @@ module Jamf
     ### @return [String]  e.g."Intel/x86"
     attr_reader :target_platform
 
-
     #####################################
     ### Constructor
     #####################################
@@ -138,14 +137,12 @@ module Jamf
       @share_point = @init_data[:share_point]
       @specific_image = @init_data[:specific_image]
       @target_platform = @init_data[:target_platform]
-
     end
 
     #####################################
     ### Public Instance Methods
     #####################################
 
-
   end # class NetbootServer
 
 end # module

data/lib/jamf/api/classic/api_objects/network_segment.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -197,6 +197,7 @@ module Jamf
         validate_ip_range(startip, endip)
       else
         raise ArgumentError, 'Must provide ending_address:, mask:, cidr: or a masked starting_address:' unless starting_address.include? '/'
+
         subnet = IPAddr.new starting_address
         startip = subnet.to_range.first.mask 32
         endip = subnet.to_range.last.mask 32
@@ -433,6 +434,7 @@ module Jamf
     def overlap?(other_segment)
       raise TypeError, 'Argument must be a Jamf::NetworkSegment' unless \
         other_segment.is_a? Jamf::NetworkSegment
+
       other_range = other_segment.range
       range.include?(other_range.begin) || range.include?(other_range.end)
     end
@@ -464,6 +466,7 @@ module Jamf
     def ==(other)
       raise TypeError, 'Argument must be a Jamf::NetworkSegment' unless \
         other.is_a? Jamf::NetworkSegment
+
       range == other.range
     end
 
@@ -496,6 +499,7 @@ module Jamf
     ###
     def override_buildings=(newval)
       raise Jamf::InvalidDataError, 'New value must be boolean true or false' unless Jamf::TRUE_FALSE.include? newval
+
       @override_buildings = newval
       @need_to_update = true
     end
@@ -512,7 +516,7 @@ module Jamf
           Jamf::BLANK
         else
           id = Jamf::Department.valid_id newval
-          raise Jamf::MissingDataError , "No department matching '#{newval}' in the JSS" unless id
+          raise Jamf::MissingDataError, "No department matching '#{newval}' in the JSS" unless id
 
           Jamf::Department.map_all_ids_to(:name)[id]
         end
@@ -529,6 +533,7 @@ module Jamf
     ###
     def override_departments=(newval)
       raise Jamf::InvalidDataError, 'New value must be boolean true or false' unless Jamf::TRUE_FALSE.include? newval
+
       @override_departments = newval
       @need_to_update = true
     end

data/lib/jamf/api/classic/api_objects/osx_configuration_profile.rb

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,7 +23,6 @@
 #
 #
 
-#
 module Jamf
 
   # Classes
@@ -94,9 +93,10 @@ module Jamf
     def level=(new_val)
       return nil if @level == new_val
       raise Jamf::InvalidDataError, "New value must be one of '#{LEVELS.join("' '")}'" unless LEVELS.include? new_val
+
       @level = new_val
       @need_to_update = true
-    end #
+    end
 
     # Private Instance Methods
     ###################################

data/lib/jamf/api/classic/api_objects/package.rb

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -31,11 +31,17 @@ module Jamf
   # Classes
   #####################################
 
+  # @deprecated Use {Jamf::JPackage} instead.
+  # This class will be removed in a future release.
+  #
   # A Package in the JSS
   #
   # Also the API provides no access to the package's
   # file list (index), so indexing must be done separately (usually via Casper Admin)
   #
+  # For accessing packages via the Jamf Pro API, see {Jamf::JPackage}
+  # which provides access to the other package-related attributes such as manifests and
+  # installer file uploads
   class Package < Jamf::APIObject
 
     # Mix-Ins
@@ -220,8 +226,9 @@ module Jamf
     #
     # @return [String] The checksum of the file
     #
-    def self.calculate_checksum(filepath, type = DEFAULT_CHECKSUM_HASH_TYPE )
+    def self.calculate_checksum(filepath, type = DEFAULT_CHECKSUM_HASH_TYPE)
       raise ArgumentError, 'Unknown checksum hash type' unless CHECKSUM_HASH_TYPES.key? type
+
       CHECKSUM_HASH_TYPES[type].file(filepath).hexdigest
     end
 
@@ -319,10 +326,9 @@ module Jamf
       @send_notification = @init_data[:send_notification]
       @switch_with_package = @init_data[:switch_with_package] || DO_NOT_INSTALL
 
-      @checksum = @init_data[:hash_value] #ill be nil if no checksum
+      @checksum = @init_data[:hash_value] # ill be nil if no checksum
       @checksum_type = @checksum ? @init_data[:hash_type] : DEFAULT_CHECKSUM_HASH_TYPE
 
-
       # the receipt is the filename with any .zip extension removed.
       @receipt = @filename ? (Jamf::Client::RECEIPTS_FOLDER + @filename.to_s.sub(/.zip$/, '')) : nil
     end # init
@@ -357,8 +363,10 @@ module Jamf
     #
     def boot_volume_required=(new_val)
       return nil if new_val == @boot_volume_required
+
       new_val = false if new_val.to_s.empty?
       raise Jamf::InvalidDataError, 'install_if_reported_available must be boolean true or false' unless Jamf::TRUE_FALSE.include? new_val
+
       @boot_volume_required = new_val
       @need_to_update = true
     end
@@ -387,8 +395,10 @@ module Jamf
     #
     def fill_existing_users=(new_val)
       return nil if new_val == @fill_existing_users
+
       new_val = false if new_val.to_s.empty?
       raise Jamf::InvalidDataError, "fill_existing_users must be boolean 'true' or 'false'" unless Jamf::TRUE_FALSE.include? new_val
+
       @fill_existing_users = new_val
       @need_to_update = true
     end
@@ -401,8 +411,10 @@ module Jamf
     #
     def fill_user_template=(new_val)
       return nil if new_val == @fill_user_template
+
       new_val = false if new_val.to_s.empty?
       raise Jamf::InvalidDataError, "fill_user_template must be boolean 'true' or 'false'" unless Jamf::TRUE_FALSE.include? new_val
+
       @fill_user_template = new_val
       @need_to_update = true
     end
@@ -415,6 +427,7 @@ module Jamf
     #
     def info=(new_val)
       return nil if new_val == @info
+
       # line breaks should be \r
       new_val = new_val.to_s.tr("\n", "\r")
       @info = new_val
@@ -429,8 +442,10 @@ module Jamf
     #
     def install_if_reported_available=(new_val)
       return nil if new_val == @install_if_reported_available
+
       new_val = false if new_val.to_s.empty?
       raise Jamf::InvalidDataError, 'install_if_reported_available must be boolean true or false' unless Jamf::TRUE_FALSE.include? new_val
+
       @install_if_reported_available = new_val
       @need_to_update = true
     end
@@ -531,8 +546,10 @@ module Jamf
     #
     def priority=(new_val)
       return nil if new_val == @priority
+
       new_val = DEFAULT_PRIORITY if new_val.to_s.empty?
       raise Jamf::InvalidDataError, ':priority must be an integer from 1-20' unless PRIORITIES.include? new_val
+
       @priority = new_val
       @need_to_update = true
     end
@@ -545,8 +562,10 @@ module Jamf
     #
     def reboot_required=(new_val)
       return nil if new_val == @reboot_required
+
       new_val = false if new_val.to_s.empty?
       raise Jamf::InvalidDataError, "reboot must be boolean 'true' or 'false'" unless Jamf::TRUE_FALSE.include? new_val
+
       @reboot_required = new_val
       @need_to_update = true
     end
@@ -588,8 +607,10 @@ module Jamf
     #
     def send_notification=(new_val)
       return nil if new_val == @send_notification
+
       new_val = false if new_val.to_s.empty?
       raise Jamf::InvalidDataError, 'send_notification must be boolean true or false' unless Jamf::TRUE_FALSE.include? new_val
+
       @send_notification = new_val
       @need_to_update = true
     end
@@ -602,6 +623,7 @@ module Jamf
     #
     def switch_with_package=(new_val)
       return nil if new_val == @switch_with_package
+
       new_val = nil if new_val.to_s.empty?
 
       raise Jamf::NoSuchItemError, "No package named '#{new_val}' exists in the JSS" if new_val && (!self.class.all_names(cnx: @cnx).include? new_val)
@@ -712,7 +734,7 @@ module Jamf
     #
     # @return [void]
     #
-    def reset_checksum(type: nil, local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true, dist_point: nil )
+    def reset_checksum(type: nil, local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true, dist_point: nil)
       type ||= DEFAULT_CHECKSUM_HASH_TYPE
 
       new_checksum = calculate_checksum(
@@ -754,7 +776,7 @@ module Jamf
     #
     # @return [String] The calculated checksum
     #
-    def calculate_checksum(type: nil, local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true, dist_point: nil )
+    def calculate_checksum(type: nil, local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true, dist_point: nil)
       type ||= DEFAULT_CHECKSUM_HASH_TYPE
       dp = self.class.fetch_dist_point(dist_point, cnx: @cnx)
 
@@ -798,8 +820,9 @@ module Jamf
     # @return [Boolean] false if there is no checksum for this pkg, otherwise,
     #   does the calculated checksum match the one stored for the pkg?
     #
-    def checksum_valid?(local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true, dist_point: nil )
+    def checksum_valid?(local_file: nil, rw_pw: nil, ro_pw: nil, unmount: true, dist_point: nil)
       return false unless @checksum
+
       new_checksum = calculate_checksum(
         type: @checksum_type,
         local_file: local_file,
@@ -829,6 +852,7 @@ module Jamf
     #
     def update_master_filename(old_file_name, new_file_name, rw_pw, unmount = true, dist_point: nil)
       raise Jamf::NoSuchItemError, "#{old_file_name} does not exist in the jss." unless @in_jss
+
       dp = self.class.fetch_dist_point(dist_point, cnx: @cnx)
 
       pkgs_dir = dp.mount(rw_pw, :rw) + DIST_POINT_PKGS_FOLDER.to_s
@@ -845,8 +869,6 @@ module Jamf
       nil
     end # update_master_filename
 
-
-
     # Delete the filename from the master distribution point, if it exists.
     #
     # If you'll be uploading several files you can specify unmount as false, and do it manually when all
@@ -970,9 +992,11 @@ module Jamf
           if mdp.username_password_required
             raise Jamf::MissingDataError, 'No password provided for http download' unless ro_pw
             raise Jamf::InvaldDatatError, 'Incorrect password for http access to distribution point.' unless mdp.check_pw(:http, ro_pw)
+
             # insert the name and pw into the uri
             # reserved_chars = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]") # we'll escape all the chars that aren't unreserved
-            src_path = src_path.sub(%r{(https?://)(\S)}, "#{Regexp.last_match(1)}#{CGI.escape mdp.http_username.to_s}:#{CGI.escape ro_pw.to_s}@#{Regexp.last_match(2)}")
+            src_path = src_path.sub(%r{(https?://)(\S)},
+                                    "#{Regexp.last_match(1)}#{CGI.escape mdp.http_username.to_s}:#{CGI.escape ro_pw.to_s}@#{Regexp.last_match(2)}")
           end
 
         # or with filesharing?
@@ -985,9 +1009,7 @@ module Jamf
         src_path += "#{DIST_POINT_PKGS_FOLDER}/"
       end # if args[:alt_download_url]
 
-      if using_http
-        src_path += @filename.to_s unless no_filename_in_url
-      end
+      src_path += @filename.to_s if using_http && !no_filename_in_url
 
       # are we doing "fill existing users" or "fill user template"?
       do_feu = args[:feu] ? '-feu' : ''
@@ -1003,9 +1025,7 @@ module Jamf
       install_exit = Regexp.last_match(1) ? Regexp.last_match(1).to_i : nil
       install_exit ||= $CHILD_STATUS.exitstatus
 
-      if args.include? :unmount
-        mdp.unmount unless using_http
-      end
+      mdp.unmount if args.include?(:unmount) && !using_http
 
       install_exit.zero? ? true : false
     end
@@ -1032,6 +1052,7 @@ module Jamf
               'This package cannot be uninstalled. Please use CasperAdmin to index it and allow uninstalls'
       end
       raise Jamf::UnsupportedError, 'You must have root privileges to uninstall packages' unless JSS.superuser?
+
       args[:target] ||= '/'
 
       # are we doing "fill existing users" or "fill user template"?
@@ -1094,7 +1115,6 @@ module Jamf
 
     private
 
-
     # Return the REST XML for this pkg, with the current values,
     # for saving or updating
     #

data/lib/jamf/api/classic/api_objects/patch_external_source.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -48,7 +48,6 @@ module Jamf
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :patch_external_source
 
-
     # Instance Methods
     #####################################
 
@@ -58,6 +57,7 @@ module Jamf
     #
     def enable
       return if enabled?
+
       validate_host_port('enable a patch source')
       @enabled = true
       @need_to_update = true
@@ -69,6 +69,7 @@ module Jamf
     #
     def disable
       return unless enabled?
+
       @enabled = false
       @need_to_update = true
     end
@@ -78,6 +79,7 @@ module Jamf
     def host_name=(newname)
       return if newname == host_name
       raise Jamf::InvalidDataError, 'names must be String' unless name.is_a? String
+
       @host_name = name
       @need_to_update = true
     end
@@ -89,6 +91,7 @@ module Jamf
     def port=(new_port)
       return if new_port == port
       raise Jamf::InvalidDataError, 'ports must be Integers' unless port.is_a? Integer
+
       @port = new_port
       @need_to_update = true
     end
@@ -99,6 +102,7 @@ module Jamf
     #
     def use_ssl
       return if ssl_enabled?
+
       @ssl_enabled = true
       @need_to_update = true
     end
@@ -110,6 +114,7 @@ module Jamf
     #
     def no_ssl
       return unless ssl_enabled?
+
       @ssl_enabled = false
       @need_to_update = true
     end

data/lib/jamf/api/classic/api_objects/patch_internal_source.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/classic/api_objects/patch_policy.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/classic/api_objects/patch_title/version.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/classic/api_objects/patch_title.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -437,7 +437,10 @@ module Jamf
       return @versions unless @versions.empty?
 
       # if we are in jss, and versions is empty, re-fetch them
-      @versions = self.class.fetch(id: id).versions
+      # this SHOULDN't cause a loop, and shouldn't even ever happen
+      # because for the title to be active and fetchable, there must be
+      # at least one version.
+      @versions = self.class.fetch(id: id, cnx: cnx).versions
     end
 
     # @return [Hash] Subset of @versions, containing those which have packages