ruby-jss 4.1.1 → 4.2.0

data/lib/jamf/api/classic/api_objects/script.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
 
   # Module Constants
@@ -86,7 +85,7 @@ module Jamf
     DEFAULT_PRIORITY = 'After'.freeze
 
     # The keys used in the @parameters Hash
-    PARAMETER_KEYS = [:parameter4, :parameter5, :parameter6, :parameter7, :parameter8, :parameter9, :parameter10, :parameter11].freeze
+    PARAMETER_KEYS = %i[parameter4 parameter5 parameter6 parameter7 parameter8 parameter9 parameter10 parameter11].freeze
 
     # the object type for this object in
     # the object history table.
@@ -99,7 +98,6 @@ module Jamf
     # How is the category stored in the API data?
     CATEGORY_DATA_TYPE = String
 
-
     # Attributes
     #####################################
 
@@ -132,7 +130,6 @@ module Jamf
     # Constructor
     #####################################
 
-    #
     def initialize(**args)
       super
 
@@ -140,13 +137,14 @@ module Jamf
       @info = @init_data[:info]
       @notes = @init_data[:notes]
       @os_requirements = @init_data[:os_requirements] ? JSS.to_s_and_a(@init_data[:os_requirements])[:arrayform] : []
-      @parameters = @init_data[:parameters] ? @init_data[:parameters] : {}
+      @parameters = @init_data[:parameters] || {}
       @priority = @init_data[:priority] || DEFAULT_PRIORITY
       @script_contents = @init_data[:script_contents]
       @script_contents_encoded = @init_data[:script_contents_encoded]
-      if @script_contents && @script_contents_encoded.to_s.empty?
-        @script_contents_encoded = Base64.encode64 @script_contents
-      end
+      return unless @script_contents && @script_contents_encoded.to_s.empty?
+
+      @script_contents_encoded = Base64.encode64 @script_contents
+      
     end # initialize
 
     # Change the script filename
@@ -162,7 +160,7 @@ module Jamf
     #
     def filename=(new_val)
       new_val = nil if new_val == ''
-      new_val = @name unless new_val
+      new_val ||= @name
 
       return nil if new_val == @filename
 
@@ -242,8 +240,10 @@ module Jamf
     #
     def priority=(new_val)
       return nil if new_val == @priority
+
       new_val = DEFAULT_PRIORITY if new_val.nil? || (new_val == '')
       raise Jamf::InvalidDataError, ":priority must be one of: #{PRIORITIES.join ', '}" unless PRIORITIES.include? new_val
+
       @priority = new_val
       @need_to_update = true
     end # priority=
@@ -256,6 +256,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
@@ -270,6 +271,7 @@ module Jamf
     #
     def notes=(new_val)
       return nil if new_val == @notes
+
       # line breaks should be \r
       new_val = new_val.to_s.tr("\n", "\r")
       @notes = new_val
@@ -286,11 +288,13 @@ module Jamf
     #
     def parameters=(new_val)
       return nil if new_val == @parameters
+
       new_val = {} if new_val.nil? || (new_val == '')
 
       # check the values
       raise Jamf::InvalidDataError, ':parameters must be a Hash with keys :parameter4 thru :parameter11' unless \
         new_val.is_a?(Hash) && ((new_val.keys & PARAMETER_KEYS) == new_val.keys)
+
       new_val.each do |_k, v|
         raise Jamf::InvalidDataError, ':parameter values must be strings or nil' unless v.nil? || v.is_a?(String)
       end
@@ -309,9 +313,11 @@ module Jamf
     #
     def set_parameter(param_num, new_val)
       raise Jamf::NoSuchItemError, 'Parameter numbers must be from 4-11' unless (4..11).cover? param_num
+
       pkey = "parameter#{param_num}".to_sym
       raise Jamf::InvalidDataError, 'parameter values must be strings or nil' unless new_val.nil? || new_val.is_a?(String)
       return nil if new_val == @parameters[pkey]
+
       @parameters[pkey] = new_val
       @need_to_update = true
     end
@@ -403,13 +409,13 @@ module Jamf
       params << opts[:p11]
 
       # everything must be a string
-      params.map! &:to_s
+      params.map!(&:to_s)
 
       # remove nils
       params.compact!
 
       # remove empty strings
-      params.delete_if &:empty?
+      params.delete_if(&:empty?)
 
       return_value = []
 

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

@@ -1,5 +1,4 @@
-
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -365,6 +364,7 @@ module Jamf
       new_val = new_val.strip
       return nil if @self_service_display_name == new_val
       raise Jamf::InvalidDataError, 'Only macOS Self Service items have display names' unless self_service_targets.include? :macos
+
       @self_service_display_name = new_val
       @need_to_update = true
     end
@@ -379,6 +379,7 @@ module Jamf
       new_val = new_val.strip
       return nil if @self_service_install_button_text == new_val
       raise Jamf::InvalidDataError, 'Only macOS Self Service Items can have custom button text' unless self_service_targets.include? :macos
+
       @self_service_install_button_text = new_val
       @need_to_update = true
     end
@@ -391,6 +392,7 @@ module Jamf
       new_val = new_val.strip
       return nil if @self_service_reinstall_button_text == new_val
       raise Jamf::InvalidDataError, 'Only macOS Self Service Items can have custom button text' unless self_service_targets.include? :macos
+
       @self_service_reinstall_button_text = new_val
       @need_to_update = true
     end
@@ -403,6 +405,7 @@ module Jamf
       return nil if @self_service_feature_on_main_page == new_val
       return nil unless @self_service_data_config[:can_feature_in_categories]
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @self_service_feature_on_main_page = new_val
       @need_to_update = true
     end
@@ -416,6 +419,7 @@ module Jamf
       return nil if @self_service_force_users_to_view_description == new_val
       raise Jamf::InvalidDataError, 'Only macOS Self Service Items can force users to view description' unless self_service_targets.include? :macos
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @self_service_force_users_to_view_description = new_val
       @need_to_update = true
     end
@@ -503,6 +507,7 @@ module Jamf
     #
     def self_service_notifications_enabled=(new_val)
       return if new_val == self_service_notifications_enabled
+
       validate_notifications_supported
       Jamf::Validate.boolean new_val
       @self_service_notifications_enabled = new_val
@@ -538,6 +543,7 @@ module Jamf
     def self_service_notification_subject=(subj)
       subj = subj.strip
       return if subj == @self_service_notification_subject
+
       validate_notifications_supported
       @self_service_notification_subject = subj
       @need_to_update = true
@@ -550,6 +556,7 @@ module Jamf
     def self_service_notification_message=(msg)
       msg = msg.strip
       return if msg == @self_service_notification_message
+
       validate_notifications_supported
       @self_service_notification_message = msg
       @need_to_update = true
@@ -563,6 +570,7 @@ module Jamf
     #
     def self_service_reminders_enabled=(new_val)
       return if new_val == self_service_reminders_enabled
+
       validate_notification_reminders_supported
       Jamf::Validate.boolean new_val
       @self_service_reminders_enabled = new_val
@@ -577,6 +585,7 @@ module Jamf
     #
     def self_service_reminder_frequency=(days)
       return if days == self_service_reminder_frequency
+
       validate_notification_reminders_supported
       Jamf::Validate.integer days
       @self_service_reminder_frequency = days
@@ -600,6 +609,7 @@ module Jamf
     def icon=(new_icon)
       if new_icon.is_a? Integer
         return if @icon && new_icon == @icon.id
+
         validate_icon new_icon
         @new_icon_id = new_icon
         @need_to_update = true
@@ -607,11 +617,11 @@ module Jamf
         unless uploadable? && defined?(self.class::UPLOAD_TYPES) && self.class::UPLOAD_TYPES.key?(:icon)
           raise Jamf::UnsupportedError, "Class #{self.class} does not support icon uploads."
         end
+
         new_icon = Pathname.new new_icon
         upload(:icon, new_icon)
         refresh_icon
       end # new_icon.is_a? Integer
-      new_icon
     end # icon =
     alias self_service_icon= icon=
     alias assign_icon icon=
@@ -623,6 +633,7 @@ module Jamf
     def add_to_self_service
       return nil unless @self_service_data_config[:in_self_service_data_path]
       return nil if in_self_service?
+
       @in_self_service = true
       @need_to_update = true
     end
@@ -634,6 +645,7 @@ module Jamf
     def remove_from_self_service
       return nil unless @self_service_data_config[:in_self_service_data_path]
       return nil unless in_self_service?
+
       @in_self_service = false
       @need_to_update = true
     end
@@ -644,6 +656,7 @@ module Jamf
     #
     def user_removable?
       return nil unless self_service_payload == :profile
+
       @self_service_user_removable != :never
     end
 
@@ -708,7 +721,7 @@ module Jamf
     def parse_self_service
       @self_service_data_config = SELF_SERVICE_CLASSES[self.class.to_s]
 
-      subset_key = @self_service_data_config[:self_service_subset] ? @self_service_data_config[:self_service_subset] : :self_service
+      subset_key = @self_service_data_config[:self_service_subset] || :self_service
 
       ss_data = @init_data[subset_key]
       ss_data ||= {}
@@ -746,20 +759,23 @@ module Jamf
     #
     def in_self_service_at_init?
       return nil unless @self_service_data_config[:in_self_service_data_path]
+
       subsection, key = @self_service_data_config[:in_self_service_data_path]
       return false unless @init_data[subsection]
+
       @init_data[subsection][key] == @self_service_data_config[:in_self_service]
     end
 
     # parse incoming ssvc settings for profiles
     def parse_self_service_profile(ss_data)
       return unless self_service_payload == :profile
+
       if self_service_targets.include? :ios
         @self_service_user_removable = PROFILE_REMOVAL_BY_USER[ss_data[:security][:removal_disallowed]]
         @self_service_removal_password = ss_data[:security][:password]
         return
       end
-      @self_service_user_removable =  @init_data[:general][:user_removable]
+      @self_service_user_removable = @init_data[:general][:user_removable]
     end
 
     # parse incoming ssvc notification settings
@@ -800,8 +816,9 @@ module Jamf
     #
     def refresh_icon
       return nil unless @in_jss
+
       fresh_data = @cnx.c_get(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
-      subset_key = @self_service_data_config[:self_service_subset] ? @self_service_data_config[:self_service_subset] : :self_service
+      subset_key = @self_service_data_config[:self_service_subset] || :self_service
 
       ss_data = fresh_data[subset_key]
 
@@ -856,6 +873,9 @@ module Jamf
       in_ss_section_xml = doc_root.elements[in_ss_section.to_s]
       in_ss_section_xml ||= doc_root.add_element(in_ss_section.to_s)
       in_ss_section_xml.add_element(in_ss_elem.to_s).text = in_ss_value.to_s
+      return unless self.class == Jamf::MobileDeviceApplication
+
+      in_ss_section_xml.add_element('deploy_automatically').text = (!@in_self_service).to_s
     end
 
     # add the xml specific to profiles
@@ -898,7 +918,6 @@ module Jamf
       ssvc.add_element('reinstall_button_text').text = self_service_reinstall_button_text if self_service_reinstall_button_text
     end
 
-
     # set ssvc notification settings in xml
     def add_self_service_notification_xml(ssvc)
       return unless @self_service_data_config[:notifications_supported]
@@ -923,7 +942,6 @@ module Jamf
       reminds = notif.add_element('reminders')
       reminds.add_element('notification_reminders_enabled').text = self_service_reminders_enabled.to_s
       reminds.add_element('notification_reminder_frequency').text = self_service_reminder_frequency.to_s if self_service_reminder_frequency
-
     end
 
     # Raise an error if user_removable settings are wrong

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

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -98,6 +98,7 @@ module Jamf
     #
     def site_object
       return nil unless site_assigned?
+
       Jamf::Site.fetch id: @site_id
     end # cat obj
 
@@ -149,6 +150,7 @@ module Jamf
     def unset_site
       # no change, go home
       return nil if @site_name.nil?
+
       @site_name = nil
       @site_id = nil
       @need_to_update = true

data/lib/jamf/api/classic/api_objects/site.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

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

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -60,7 +60,7 @@ module Jamf
     #####################################
 
     ### The base for REST resources of this class
-    RSRC_BASE = "softwareupdateservers"
+    RSRC_BASE = 'softwareupdateservers'
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :software_update_servers
@@ -87,7 +87,6 @@ module Jamf
     ### @return [Boolean]
     attr_reader :set_system_wide
 
-
     #####################################
     ### Constructor
     #####################################
@@ -106,7 +105,6 @@ module Jamf
     ### Public Instance Methods
     #####################################
 
-
   end # class NetbootServer
 
 end # module

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

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -80,6 +80,7 @@ module Jamf
       raise Jamf::InvalidDataError, "Names can't be empty!" if newname.to_s.empty?
       raise Jamf::AlreadyExistsError, "A #{self.class::RSRC_OBJECT_KEY} named '#{newname}' already exsists in the JSS" \
         if self.class.all_names(:refresh, cnx: @cnx).include? newname
+
       @name = newname
       @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name.to_s}" if @rest_rsrc.include? '/name/'
       @need_to_update = true

data/lib/jamf/api/classic/api_objects/uploadable.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/user.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 = "users"
+    RSRC_BASE = 'users'
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :users
@@ -113,7 +113,6 @@ module Jamf
     ###
     attr_reader :sites
 
-
     ### @return [Array<Hash>]
     ###
     ### The computers associated with this user
@@ -122,7 +121,6 @@ module Jamf
     ###
     attr_reader :computers
 
-
     ### @return [Array<Hash>]
     ###
     ### The peripherals associated with this user
@@ -169,54 +167,54 @@ module Jamf
       @position = @init_data[:position]
       @ldap_server = Jamf::APIObject.get_name @init_data[:ldap_server]
       @ldap_server_id = @init_data[:ldap_server][:id] unless @init_data[:ldap_server].nil?
-      @sites = @init_data[:sites] ? @init_data[:sites]  : []
+      @sites = @init_data[:sites] || []
 
-      if @init_data[:links]
-        @computers = @init_data[:links][:computers]
-        @peripherals = @init_data[:links][:peripherals]
-        @mobile_devices = @init_data[:links][:mobile_devices]
-        @vpp_assignments = @init_data[:links][:vpp_assignments]
-        @total_vpp_code_count = @init_data[:links][:total_vpp_code_count]
-      end
+      return unless @init_data[:links]
 
+      @computers = @init_data[:links][:computers]
+      @peripherals = @init_data[:links][:peripherals]
+      @mobile_devices = @init_data[:links][:mobile_devices]
+      @vpp_assignments = @init_data[:links][:vpp_assignments]
+      @total_vpp_code_count = @init_data[:links][:total_vpp_code_count]
+      
     end
 
     #####################################
     ### Public Instance Methods
     #####################################
 
-
     ###
     ### Simple Setters
     ###
 
     ###
-    def full_name= (new_val)
+    def full_name=(new_val)
       @full_name = new_val
       @need_to_update = true
     end
 
     ###
-    def email= (new_val)
+    def email=(new_val)
       @email = new_val
       @need_to_update = true
     end
 
     ###
-    def phone_number= (new_val)
+    def phone_number=(new_val)
       @phone_number = new_val
       @need_to_update = true
     end
 
     ###
-    def position= (new_val)
+    def position=(new_val)
       @position = new_val
       @need_to_update = true
     end
 
     ###
-    def ldap_server= (new_val)
+    def ldap_server=(new_val)
       raise Jamf::InvalidDataError, "No LDAP server in the JSS named #{new_val}" unless Jamf::LdapServer.all_names(cnx: @cnx).include? new_val
+
       @ldap_server = new_val
       @ldap_server_id = Jamf::LdapServer.valid_id @ldap_server
       @need_to_update = true
@@ -229,10 +227,11 @@ module Jamf
     ###
     ### @return [void]
     ###
-    def add_site (site)
-      return nil if @sites.map{|s| s[:name]}.include? site
+    def add_site(site)
+      return nil if @sites.map { |s| s[:name] }.include? site
       raise Jamf::InvalidDataError, "No site in the JSS named #{site}" unless Jamf::Site.all_names(cnx: @cnx).include? site
-      @sites << {:name => site}
+
+      @sites << { name: site }
       @need_to_update = true
     end
 
@@ -243,9 +242,10 @@ module Jamf
     ###
     ### @return [void]
     ###
-    def remove_site (site)
-      return nil unless @sites.map{|s| s[:name]}.include? site
-      @sites.reject!{|s| s[:name] == site}
+    def remove_site(site)
+      return nil unless @sites.map { |s| s[:name] }.include? site
+
+      @sites.reject! { |s| s[:name] == site }
       @need_to_update = true
     end
 
@@ -313,7 +313,7 @@ module Jamf
 
       user << ext_attr_xml if unsaved_eas?
 
-      return doc.to_s
+      doc.to_s
     end
 
   end # class user

data/lib/jamf/api/classic/api_objects/user_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

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

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -57,13 +57,12 @@ module Jamf
     ### Mix-Ins
     #####################################
 
-
     #####################################
     ### Class Constants
     #####################################
 
     ### The base for REST resources of this class
-    RSRC_BASE = "usergroups"
+    RSRC_BASE = 'usergroups'
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :user_groups
@@ -108,7 +107,7 @@ module Jamf
     ### @return [Array<String>] the member usernames
     ###
     def member_usernames
-      @members.map{|m| m[:username]}
+      @members.map { |m| m[:username] }
     end
 
     ###
@@ -117,7 +116,7 @@ module Jamf
     ### @return [Array<String>] the member full names
     ###
     def member_full_names
-      @members.map{|m| m[:full_name]}
+      @members.map { |m| m[:full_name] }
     end
 
     ###
@@ -126,7 +125,7 @@ module Jamf
     ### @return [Array<String>] the member phone numbers
     ###
     def member_phone_numbers
-      @members.map{|m| m[:phone_number]}
+      @members.map { |m| m[:phone_number] }
     end
 
     ###
@@ -135,14 +134,13 @@ module Jamf
     ### @return [Array<String>] the member email addresses
     ###
     def member_email_addresses
-      @members.map{|m| m[:email_address]}
+      @members.map { |m| m[:email_address] }
     end
 
     #####################################
     ### Private Instance Methods
     #####################################
 
-
   end # class UserGroup
 
 end # module

data/lib/jamf/api/classic/api_objects/vpp_account.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/vppable.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -90,7 +90,6 @@ module Jamf
 
     end # module ClassMethods
 
-
     # Mixed-in Attributes
     #####################################
 
@@ -266,6 +265,7 @@ module Jamf
       doc_root = xdoc.root
       vpp = doc_root.add_element 'vpp'
       vpp.add_element('assign_vpp_device_based_licenses').text = @assign_vpp_device_based_licenses.to_s
+      vpp.add_element('vpp_admin_account_id').text = @vpp_admin_account_id.to_s
     end
 
   end # VPPable