ruby-jss 3.0.0b1 → 3.1.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7af617b6ac8bb27cbc7d5c790a2de9fa788fb3d426ae062581654fbc9f77c5f
-  data.tar.gz: f5dfabfdde6c466951862fdc458321ad4f9384293e1fe773fb78a0ca80e51283
+  metadata.gz: 4bce47ef4c036e883a7b41d44220f6405bec40d1c3ea20f141d4923ce29dc837
+  data.tar.gz: c14adc7dc8fd8b08c31c5cbe0257b667dcb18003b30754675da0c68edf268893
 SHA512:
-  metadata.gz: 85fd8c1218206a35545cc034058996a5b03183f29ac443cf65735c547975afcedaf406f74099f610380a1b72272db5240c2427ab4e87201ef5d9ec7ceffd2f29
-  data.tar.gz: a04b06cbcb9858b06dfe738ced2943e37b6a12088da394599b6ccfae66ac0a9c1bc82a264dac02c0379308141d4cc9795594c19639f473e5684cdd62e48db368
+  metadata.gz: f8ea25d3586028883d908e6d7718b5ce8b5146d0412871c02d40f742c9bb86d7cb047c24a3a9e2e41cc3b011439fb901d7e657f4f1cf9193394d3d9ae8e75f02
+  data.tar.gz: fd6edb4cbf4941c67961c2da6863bdf37b0185f4b7512acf9c4783e8c2994e82f1f0eb8c1036227206f087c324d8695f22b869b151498956a84baa6d82a4623c

data/CHANGES.md

@@ -15,8 +15,28 @@ __Please update all installations of ruby-jss to at least v1.6.0.__
 Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue and providing examples of how it could be exploited.
 
 --------
+## \[3.1.0] 2023-06-05
 
-## \[UNRELEASED]
+### Added
+  - Jamf::Computer.filevault_info and Jamf::Computer#filevault_info can retrieve FileVault info from v1/computer-inventory/filevault and related endpoints
+  - Jamf::Computer.recovery_lock_password and Jamf::Computer#recovery_lock_password can retrieve stored recovery lock passwords
+  - There are now several ways to set scopes to all targets.
+    - The original #include_all has been renamed #set_all_targets, and #include_all is an alias to it
+    - The symbol :all can be passed to the #set_targets, and #add_target methods as they 'key' parameter, and they will just call #set_all_targets
+    - There is now a setter #all_targets=(bool) which calls #set_all_targets, or sets @all_targets to false
+
+### Fixed
+  - Fixed a bug in Jamf::Pager#initialize when constructing the query-path of the paged resource URL
+  - Fixed a bug in Jamf::Pager#initialize: The instantiate: parameter takes a class, not a boolean
+  - Fixed a bug in Jamf::CollectionResource.pager: The instantiate: parameter takes a boolean, but must pass a class to Jamf::Pager#initialize
+  - Jamf::OAPIObject base-class: can now instantiate objects that hold a single value
+
+### Changed
+  - Auto-generated OAPISchemas have been refreshed from Jamf Pro 10.46.0
+
+
+## \[3.0.0] - 2023-05-22
+Major version bump because changes to policy log flushing are not backward compatible.
 
 ### Added
   - Jamf::Policy.flush_logs_for_computers: formerly private class method, now public and used for flushing policy logs for specific computers.
@@ -29,7 +49,7 @@ Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue an
   - A validation method wasn't passing cnx param correctly.
 
 ### Changed
-  - MacOSManagedUpdates.send_managed_os_update takes symbols as the updateAction
+  - MacOSManagedUpdates.send_managed_os_update takes symbols or strings as the updateAction, a key or a value from the UPDATE_ACTIONS constant
 
 ## \[2.1.1] - 2022-11-07
 

data/README.md

@@ -6,7 +6,7 @@
 Version 2.0.0 has major changes! While we've strived for _mostly_ being backward compatible, and have done lots of testing, YMMV.  Please report any issues.
 
 _NOTE_: ruby-jss 2.0 is not completely backward compatible, please see  [README-2.0.0.md](README-2.0.0.md) for more info
- 
+
 ### Highlights
 
 - Support for Ruby 3.x
@@ -57,7 +57,6 @@ Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue an
 - [BEYOND THE API](#beyond-the-api)
 - [INSTALL](#install)
 - [REQUIREMENTS](#requirements)
-  - [Contact](#contact)
 - [HELP & CONTACT INFO](#help--contact-info)
 - [LICENSE](#license)
 
@@ -65,13 +64,13 @@ Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue an
 
 ## DESCRIPTION
 
-ruby-jss defines a Ruby module called `Jamf`, which is used for accessing the 'Classic' and 
+ruby-jss defines a Ruby module called `Jamf`, which is used for accessing the 'Classic' and
 'Jamf Pro' APIs of a Jamf Pro server. Jamf Pro is an enterprise-level management tool for Apple
 devices from [Jamf.com](http://www.jamf.com/).  It is available as a[ruby gem](https://rubygems.org/gems/ruby-jss), and the
 [source is on github](https://github.com/PixarAnimationStudios/ruby-jss).
 
 The Jamf module maintains connections to both APIs simultaneously, and uses which ever is appropriate as needed.
-Details like authentication tokens, token refreshing, JSON and XML parsing, and even knowing which resources use 
+Details like authentication tokens, token refreshing, JSON and XML parsing, and even knowing which resources use
 which API are all handled under-the-hood.
 
 The Jamf module abstracts many API resources as Ruby objects, and provides methods for interacting with those
@@ -79,8 +78,8 @@ resources. It also provides some features that aren't a part of the API itself,
 Jamf-related tools, such as uploading {Jamf::Package} files to the master distribution
 point, and the installation of those objects on client machines. (See [BEYOND THE API](#beyond-the-api))
 
-The Jamf module is not a complete implementation of the Jamf Pro APIs. Only some objects are modeled, 
-some only minimally. Of those, some are read-only, some partially writable, some fully read-write. 
+The Jamf module is not a complete implementation of the Jamf Pro APIs. Only some objects are modeled,
+some only minimally. Of those, some are read-only, some partially writable, some fully read-write.
 We've implemented the things we need in our environment, and as our needs grow, we'll add more.
 Hopefully others will find it useful, and add more to it as well.
 
@@ -138,14 +137,14 @@ ns.save
 
 Before you can work with Jamf Pros Objects via the APIs, you have to connect to the server.
 
-The method `Jamf.cnx` returns the 'default' connection object (an instance of a {Jamf::APIConnection}, q.v.). 
+The method `Jamf.cnx` returns the 'default' connection object (an instance of a {Jamf::APIConnection}, q.v.).
 A connection object holds all the data needed to communicate with the server to which it's connected, as well as
-any data cached from that server. 
+any data cached from that server.
 The default connection object is used for all communication unless a different one is explicitly passed to methods
 that can accept one. See 'Using multiple connections' below.
 
 When the Jamf Module is first loaded, the default connection isn't connected a server. To remedy that, use `Jamf.cnx.connect`,
-passing it parameters for the connection. In this example, those parameters are stored in the local variables jss_user, 
+passing it parameters for the connection. In this example, those parameters are stored in the local variables jss_user,
 jss_user_pw, and jss_server_hostname, and others are left as default.
 
 ```ruby
@@ -170,8 +169,8 @@ server connection parameters in a simple config file.
 
 #### Using multiple connections
 
-Most of the time, you'll only need a single connection to a single server, and the default connection will be sufficient. However 
-you can also create multiple Connection objects, to different servers, or perhaps the same server with different credentials and 
+Most of the time, you'll only need a single connection to a single server, and the default connection will be sufficient. However
+you can also create multiple Connection objects, to different servers, or perhaps the same server with different credentials and
 access, and pass those connection objects into methods using the `cnx:` parameter as appropriate.
 
 ```ruby
@@ -194,13 +193,13 @@ common_ipr_sns = ipr_sns_1 & ipr_sns_2
 
 ### Working with Jamf Objects
 
-All of the ruby classes representing objects in Jamf Pro have common methods for creating, listing, retrieving, updating, and deleting via the API. 
+All of the ruby classes representing objects in Jamf Pro have common methods for creating, listing, retrieving, updating, and deleting via the API.
 All supported objects can be listed, retrieved and deleted, but only some can be updated or created, mostly becase we haven't needed to do that ourselves
 yet and haven't implemented that functionality.  If you need additional features implemented, please get in touch (see 'Contact' above) or feel free to
 try implementing it yourself and send us a merge request.
 
-Some of the implemented objects also provide access to more 'functional' API resources. For example, the API resources for 
-sending MDM commands to computers and mobile devices are available as class and instance methods of Jamf::Computer and Jamf::MobileDevice, 
+Some of the implemented objects also provide access to more 'functional' API resources. For example, the API resources for
+sending MDM commands to computers and mobile devices are available as class and instance methods of Jamf::Computer and Jamf::MobileDevice,
 as are the API resources for accessing management history.
 
 --------
@@ -474,27 +473,19 @@ It also requires other ruby gems, which will be installed automatically if you i
 See the .gemspec file for details
 
 
-### Contact
-
-If you have questions or feedback about ruby-jss, please reach out  to us via:
-- The [#ruby-jss channel of Macadmins Slack](https://macadmins.slack.com/archives/C03C7F563MK)
-- Open an issue on GitHub
-- Email ruby-jss@pixar.com
-
-
 ## HELP & CONTACT INFO
 
 Full documentation is available at [rubydoc.info](http://www.rubydoc.info/gems/ruby-jss/).
 
 There's a [wiki on the github page](https://github.com/PixarAnimationStudios/ruby-jss/wiki), feel free to contribute examples and tidbits.
 
-You can report issues in several ways:
+If you have questions or feedback about ruby-jss, please reach out  to us via:
 - [Open an issue on github](https://github.com/PixarAnimationStudios/ruby-jss/issues)
 - [Email the developers at ruby-jss@pixar.com](mailto:ruby-jss@pixar.com)
 - Join the conversation in the [#ruby-jss Macadmins Slack Channel](https://macadmins.slack.com/archives/C03C7F563MK)
 
 ## LICENSE
 
-Copyright 2022 Pixar
+Copyright 2023 Pixar
 
 Licensed under a modified Apache License, Version 2.0. See LICENSE.txt for details

data/bin/cgrouper

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/bin/jamfHelperBackgrounder

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/bin/netseg-update

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/data/ruby-jss.conf.example

@@ -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/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/advanced_computer_search.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -26,19 +26,15 @@
 ###
 module Jamf
 
-
   # Module Variables
   #####################################
 
-
   # Module Methods
   #####################################
 
-
   # Classes
   #####################################
 
-
   # An AdvancedComputerSearch in the JSS
   #
   # @see Jamf::AdvancedSearch
@@ -47,11 +43,9 @@ module Jamf
   #
   class AdvancedComputerSearch < Jamf::AdvancedSearch
 
-
     # Mix-Ins
     #####################################
 
-
     # Class Constants
     #####################################
 
@@ -70,7 +64,7 @@ module Jamf
 
     # what data fields come back along with the display fields
     # for each computer?
-    RESULT_ID_FIELDS = [:id, :name, :udid].freeze
+    RESULT_ID_FIELDS = %i[id name udid].freeze
 
     # the object type for this object in
     # the object history table.
@@ -80,15 +74,12 @@ module Jamf
     # Attributes
     #####################################
 
-
     # Constructor
     #####################################
 
-
     # Public Instance Methods
     #####################################
 
-
     # Private Instance Methods
     #####################################
 

data/lib/jamf/api/classic/api_objects/advanced_mobile_device_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/api_objects/advanced_user_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/api_objects/building.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/categorizable.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/category.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/computer.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -160,6 +160,8 @@ module Jamf
     include Jamf::ManagementHistory
     include Jamf::MacOSManagedUpdates
     include Jamf::MacOSRedeployMgmtFramework
+    include Jamf::FileVault
+    include Jamf::ComputerRecoveryLock
 
     extend Jamf::Matchable
 
@@ -265,6 +267,12 @@ module Jamf
 
     COMPUTER_APPLICATIONS_RSRC = 'computerapplications/application'.freeze
 
+    # The base resource for computer data in the JPAPI
+    JPAPI_INVENTORY_RSRC = 'v1/computers-inventory'
+
+    # The resource for getting all inventory data for a computer at once
+    JPAPI_INVENTORY_DETAIL_RSRC = 'v1/computers-inventory-detail'
+
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}

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

@@ -1,45 +1,45 @@
-# 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
 #    compliance with the Apache License and the following modification to it:
 #    Section 6. Trademarks. is deleted and replaced with:
-# 
+#
 #    6. Trademarks. This License does not grant permission to use the trade
 #       names, trademarks, service marks, or product names of the Licensor
 #       and its affiliates, except as required to comply with Section 4(c) of
 #       the License and to reproduce the content of the NOTICE file.
-# 
+#
 #    You may obtain a copy of the Apache License at
-# 
+#
 #        http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 #    Unless required by applicable law or agreed to in writing, software
 #    distributed under the Apache License with the above modification is
 #    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 #    KIND, either express or implied. See the Apache License for the specific
 #    language governing permissions and limitations under the Apache License.
-# 
-# 
+#
+#
 
 module Jamf
 
   # Classes
   #####################################
 
-  
+
   # A computer group in the JSS
-  # 
+  #
   # See also the parent class Jamf::Group
-  # 
+  #
   # @see Jamf::APIObject
-  # 
+  #
   # @see Jamf::Group
-  # 
+  #
   class ComputerGroup < Jamf::Group
 
-    
+
     # Mix-Ins
     #####################################
     include Jamf::MDM
@@ -79,20 +79,20 @@ module Jamf
     # Public Instance Methods
     #####################################
 
-    # 
+    #
     # The serial numbers of members in this group
-    # 
+    #
     # @return [Array<String>] the member serial numbers
-    # 
+    #
     def member_serial_numbers
       @members.map { |m| m[:serial_number] }
     end
 
-    # 
+    #
     # Return an array of the mac_addrs of members in this group
-    # 
+    #
     # @return [Array<String>] the member mac addresses
-    # 
+    #
     def member_mac_addresses
       @members.map { |m| m[:mac_address] } + @members.map { |m| m[:alt_mac_address] }
     end

data/lib/jamf/api/classic/api_objects/computer_invitation.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/creatable.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/criteriable/criteria.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/criteriable/criterion.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/criteriable.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/department.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/distribution_point.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/ebook.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/extendable.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/ibeacon.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/icon.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/ldap_server.rb

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