ruby-jss 3.0.0 → 3.1.0b2

data/lib/jamf/api/classic/api_objects/management_history/mobile_device_app.rb

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

data/lib/jamf/api/classic/api_objects/management_history/policy_log.rb

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

data/lib/jamf/api/classic/api_objects/management_history/screen_sharing_log.rb

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

data/lib/jamf/api/classic/api_objects/management_history/user_location_change.rb

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,13 +24,10 @@
 
 # This is just a stub for now.
 
-#
 module Jamf
 
-  #
   class MobileDeviceConfigurationProfile < Jamf::ConfigurationProfile
 
-
     ### The base for REST resources of this class
     RSRC_BASE = 'mobiledeviceconfigurationprofiles'.freeze
 
@@ -76,9 +73,10 @@ module Jamf
     def redeploy_days_before_certificate_expires=(new_val)
       return nil if redeploy_days_before_certificate_expires == new_val
       raise Jamf::InvalidDataError, 'New value must be an integer >= 0' unless new_val.is_a?(Integer) && new_val >= 0
+
       @redeploy_days_before_certificate_expires = new_val
       @need_to_update = true
-    end #
+    end
 
     # Private Instance Methods
     ###################################

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

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 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/mobile_device_group.rb

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 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 2022 Pixar
+### Copyright 2023 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 2022 Pixar
+### Copyright 2023 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 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/jamf/api/classic/api_objects/scopable/scope.rb

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 Pixar
 
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -397,7 +397,7 @@ module Jamf
       #
       # @return [void]
       #
-      def include_all(clear = false)
+      def set_all_targets(clear = false)
         @targets = {}
         @target_keys.each { |k| @targets[k] = [] }
         @all_targets = true
@@ -410,6 +410,7 @@ module Jamf
         end
         @container&.should_update
       end
+      alias include_all set_all_targets
 
       # Replace a list of item names for as targets in this scope.
       #
@@ -419,7 +420,8 @@ module Jamf
       # if the item doesn't exist.
       #
       # @param key[Symbol] the key from #{SCOPING_CLASSES} for the kind of items
-      # being included, :computer, :building, etc...
+      # being included, :computer, :building, etc... Use :all to scope to all targets
+      # (the same as calling #set_all_targets)
       #
       # @param list[Array]  identifiers of the items being added
       #
@@ -428,7 +430,12 @@ module Jamf
       #
       # @return [void]
       #
-      def set_targets(key, list)
+      def set_targets(key, list = nil)
+        if key == :all
+          set_all_targets
+          return
+        end
+
         key = pluralize_key(key)
         raise Jamf::InvalidDataError, "List must be an Array of #{key} identifiers, it may be empty." unless list.is_a? Array
 
@@ -454,12 +461,28 @@ module Jamf
       alias set_inclusion set_targets
       alias set_inclusions set_targets
 
+      # to match the all_targets and all_targets? methods
+      # Just calls #set_all_targets
+      #
+      # @param bool [Boolean] shou\d this scope include all targets?
+      #
+      # @return [void]
+      def all_targets=(bool)
+        if Jamf::Validate.boolean bool
+          set_all_targets
+        else
+          @all_targets = false
+          @container&.should_update
+        end
+      end
+
       # Add a single item as a target in this scope.
       #
       # The item name will be checked for existence in the JSS, and an exception
       #  raised if the item doesn't exist.
       #
       # @param key[Symbol] the key from #{SCOPING_CLASSES} for the kind of item being added, :computer, :building, etc...
+      #   Use :all to scope to all targets (the same as calling #set_all_targets)
       #
       # @param item[String,integer] a valid identifier of the item being added
       #
@@ -471,7 +494,12 @@ module Jamf
       #
       # @return [void]
       #
-      def add_target(key, item)
+      def add_target(key, item = nil)
+        if key == :all
+          set_all_targets
+          return
+        end
+
         key = pluralize_key(key)
         item_id = validate_item(:target, key, item)
         return if @targets[key]&.include?(item_id)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 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 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 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 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 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 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 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/base_classes/advanced_search.rb

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

data/lib/jamf/api/classic/base_classes/api_object.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -315,7 +315,7 @@ module Jamf
           als_name = als.to_s.end_with?('s') ? "all_#{als}es" : "all_#{als}s"
 
           next if singleton_methods.include? als_name.to_sym
-          
+
           define_singleton_method als_name do |refresh = false, api: nil, cnx: Jamf.cnx|
             cnx = api if api
             send meth_name, refresh, cnx: cnx
@@ -324,7 +324,7 @@ module Jamf
 
         end # if
       end # lookup_keys.each
-      
+
       true
     end # self.define_identifier_list_methods
 
@@ -674,16 +674,16 @@ module Jamf
     # is undefined. In short - dont' use names here unless you know they are
     # unique.
     #
-    # NOTE: Integers passed in as strings, e.g. '12345' will be converted to 
+    # NOTE: Integers passed in as strings, e.g. '12345' will be converted to
     # integers and return the matching integer id if it exists.
     #
     # This means that if you have names that might match '12345' and you use
-    #    valid_id '12345' 
+    #    valid_id '12345'
     # you will get back the id 12345, if such an id exists, even if it is not
     # the object with the name '12345'
     #
     # To explicitly look for '12345' as a name, use:
-    #      valid_id name: '12345' 
+    #      valid_id name: '12345'
     #   See the ident_and_val param below.
     #
     # @param identfier [String,Integer] An identifier for an object, a value for
@@ -697,7 +697,7 @@ module Jamf
     #
     # @param ident_and_val [Hash] Do not pass in Hash.
     #   This Hash internally holds the arbitrary identifier key
-    #   and desired value when you call ".valid_id ident: 'value'", e.g. 
+    #   and desired value when you call ".valid_id ident: 'value'", e.g.
     #   ".valid_id name: 'somename'" or ".valid_id udid: some_udid"
     #   Using explicit identifier keys like this will speed things up, since
     #   the method doesn't have to search through all available identifiers
@@ -746,7 +746,7 @@ module Jamf
       if identifier.is_a?(String) && identifier.j_integer?
         int_id = identifier.to_i
         return int_id if all_ids(cnx: cnx).include? int_id
-      end 
+      end
 
       # Now go through all the other identifier keys
       keys_to_check = lookup_keys(no_aliases: true)
@@ -1142,7 +1142,7 @@ module Jamf
         raise Jamf::UnsupportedError, "Creating #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows."
       end
       raise ArgumentError, "Use '#{self.class}.fetch id: xx' to retrieve existing JSS objects" if args[:id]
-      
+
       args[:cnx] ||= args[:api] # deprecated
       args[:cnx] ||= Jamf.cnx
       args[:id] = :new
@@ -1568,7 +1568,7 @@ module Jamf
       raise Jamf::InvalidConnectionError, 'Not connected to MySQL' unless Jamf::DB_CNX.connected?
 
       unless defined? self.class::OBJECT_HISTORY_OBJECT_TYPE
-        raise Jamf::UnsupportedError, 
+        raise Jamf::UnsupportedError,
               "Object History access is not supported for #{self.class} objects at this time"
       end
     end

data/lib/jamf/api/classic/base_classes/configuration_profile.rb

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

data/lib/jamf/api/classic/base_classes/extension_attribute.rb

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

data/lib/jamf/api/classic/base_classes/group.rb

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -351,7 +351,7 @@ module Jamf
     end
     # backward compatility
     alias set_static make_static
-        
+
     # How many members of the group?
     #
     # @return [Integer] the number of members of the group
@@ -439,7 +439,7 @@ module Jamf
       return unless id_to_remove && member_ids.include?(id_to_remove)
 
       @members.delete_if { |k, v| k == :id && v == id_to_remove }
-      @need_to_update = true 
+      @need_to_update = true
     end
 
     # Remove all members
@@ -482,7 +482,7 @@ module Jamf
     def refresh_members
       @members = @cnx.c_get(@rest_rsrc)[self.class::RSRC_OBJECT_KEY][self.class::MEMBER_CLASS::RSRC_LIST_KEY]
     end
-  
+
 
     # Public Instance Methods
     #####################################
@@ -500,7 +500,7 @@ module Jamf
 
       desired_name = self.class::MEMBER_CLASS.map_all(:id, to: :name, cnx: @cnx)[desired_id]
 
-      { name: desired_name, id: desired_id }      
+      { name: desired_name, id: desired_id }
     end
 
     # the xml formated data for adding or updating this in the JSS,

data/lib/jamf/api/classic/base_classes/patch_source.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -327,7 +327,7 @@ module Jamf
     # Init
     def initialize(**args)
       if instance_of?(Jamf::PatchSource)
-        raise Jamf::UnsupportedError, 
+        raise Jamf::UnsupportedError,
               'PatchSource is an abstract metaclass. Please use PatchInternalSource or PatchExternalSource'
       end
 

data/lib/jamf/api/classic/xml_workaround.rb

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

data/lib/jamf/api/connection/attributes.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 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/connection/cache.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 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/connection/classic_api.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 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/connection/connect.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
 ###    with the following modification; you may not use this file except in
@@ -145,7 +145,7 @@ module Jamf
       # @option params :sticky_session [Boolean] Use a 'sticky session'? Default is false.
       #   The hostname of Jamf Cloud urls does not point to a single https server,
       #   but any node of a cluster. Those nodes often take time to see changes
-      #   made in other node. Sometimes, its important to perform a series of API 
+      #   made in other node. Sometimes, its important to perform a series of API
       #   actions to the same node, to avoid sync-timing problems between node. Setting
       #   sticky_session to true will cause all communication for this Connection to go
       #   through the one specific node it first connected ith.
@@ -208,11 +208,11 @@ module Jamf
       alias login connect
 
       # If a sticky_session was requested when the connection was made, and
-      # we are connected to a jamf cloud server, the token's http response 
-      # contains the cookie we need to send with every request to ensure a 
+      # we are connected to a jamf cloud server, the token's http response
+      # contains the cookie we need to send with every request to ensure a
       # stickey session.
       #################################
-      def enable_sticky_session(headers) 
+      def enable_sticky_session(headers)
         # commas separate the cookies
         raw_cookies = headers[Jamf::Connection::SET_COOKIE_HEADER].split(/\s*,\s*/)
 
@@ -227,7 +227,7 @@ module Jamf
 
           @sticky_session_cookie = "#{Jamf::Connection::STICKY_SESSION_COOKIE_NAME}=#{cookie_value}"
           jp_cnx.headers[Jamf::Connection::COOKIE_HEADER] = @sticky_session_cookie
-          c_cnx.headers[Jamf::Connection::COOKIE_HEADER] = @sticky_session_cookie 
+          c_cnx.headers[Jamf::Connection::COOKIE_HEADER] = @sticky_session_cookie
           return @sticky_session_cookie
         end
         # be sure to return nil if there was no appropriate cookie,

data/lib/jamf/api/connection/constants.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
 ###    with the following modification; you may not use this file except in