RubyGems - ruby-jss - Versions diffs - 4.1.1 → 4.2.0 - Mend

ruby-jss 4.1.1 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (779) hide show

data/lib/jamf/api/jamf_pro/mixins/collection_resource.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -164,8 +164,6 @@ module Jamf
       # By default, this method will return a single Array data about all items
       # in the CollectionResouce, in the server's default sort order, or a sort
       # order you specify.
-      # As long as you don't request a filtered result, this full list is cached
-      # for future use (see Caching, below)
       #
       # If you specify a filter, the Array returned by the server will contain
       # only matching objects, and it will not be cached.
@@ -190,10 +188,6 @@ module Jamf
       # Please see the JamfPro API documentation for the resource for details
       # about available sorting properties and default sorting criteria
       #
-      # When the sort: param is provided, the server is always queried, and
-      # the results will be cached, as long as the results were not filtered.
-      # See Caching, below.
-      #
       # #### Filtering
       #
       # Some CollectionResouces support RSQL filters to limit which objects
@@ -386,6 +380,9 @@ module Jamf
         # if we're here, we should know our ident key and value
         raise ArgumentError, 'Required parameter "identifier: value", where identifier is id:, name: etc.' unless ident && value
+        # if the ident is :name, and there's a constant for the name attr, use that
+        ident = self::OBJECT_NAME_ATTR if defined?(self::OBJECT_NAME_ATTR) && ident == :name
         return raw_data_by_id(value, cnx: cnx) if ident == :id
         return unless identifiers.include? ident
@@ -427,6 +424,7 @@ module Jamf
         return pager(filter: "#{identifier}==\"#{value}\"", page_size: 1, cnx: cnx).page(:first).first if filterable? && filter_keys.include?(identifier)
         # otherwise we have to loop thru all the objects looking for the value
+        # which can be slow if there are lots of objects.
         cmp_val = value.to_s
         all(cnx: cnx).each do |data|
           return data if data[identifier].to_s.casecmp? cmp_val
@@ -475,7 +473,16 @@ module Jamf
       #
       ######################################
       def valid_id(searchterm = nil, cnx: Jamf.cnx, **ident_and_val)
-        raw_data(searchterm, cnx: cnx, **ident_and_val)&.dig(:id)
+        data =
+          if ident_and_val.empty?
+            raw_data(searchterm, cnx: cnx)
+          else
+            ident = ident_and_val.keys.first
+            value = ident_and_val.values.first
+            raw_data(cnx: cnx, ident: ident, value: value)
+          end
+        data&.dig(:id)
       end
       # By default, Collection Resources are creatable,
@@ -591,28 +598,35 @@ module Jamf
       # Dynamically create_identifier_list_methods
       # when one is called.
+      ######################################
       def method_missing(method, *args, &block)
         if available_list_methods.key? method.to_s
           attr_name = available_list_methods[method.to_s]
           create_identifier_list_method attr_name.to_sym, method
           send method, *args
+        elsif method.to_s == 'all_names' && defined?(self::OBJECT_NAME_ATTR)
+          define_singleton_method(:all_names) do |_refresh = nil, cnx: Jamf.cnx, cached_list: nil|
+            send "all_#{self::OBJECT_NAME_ATTR}s", *args
+          end
+          send method, *args
         else
           super
         end
       end
       # this is needed to prevent problems with method_missing!
+      ######################################
       def respond_to_missing?(method, *)
-        available_list_methods.key?(method.to_s) || super
+        available_list_methods.key?(method.to_s) || method.to_s == 'all_names' || super
       end
       # @return [Hash{String: Symbol}] Method name to matching attribute name for
       #   all identifiers
+      ######################################
       def available_list_methods
         return @available_list_methods if @available_list_methods
         @available_list_methods = {}
         identifiers.each do |i|
           meth_name = i.to_s.end_with?('s') ? "all_#{i}es" : "all_#{i}s"
           @available_list_methods[meth_name] = i

data/lib/jamf/api/jamf_pro/mixins/computer_recovery_lock.rb CHANGED Viewed

@@ -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/jamf_pro/mixins/filevault.rb CHANGED Viewed

@@ -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/jamf_pro/mixins/filterable.rb CHANGED Viewed

@@ -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
@@ -31,6 +31,8 @@ module Jamf
   #
   # Classes doing so must define the FILTER_KEYS constant, an Array of
   # Symbols of keys from OAPI_PROPERTIES which can be used in filters.
+  #
+  # TODO: Actually implement this module in CollectionResources?
   module Filterable
     def self.extended(extender)
@@ -41,6 +43,12 @@ module Jamf
     # generate the RSQL filter to put into the url
     # This is callable from anywhere without mixing in.
+    #
+    # @param filter [String, nil] the filter to apply, or nil. If the
+    #   filter starts with FILTER_PARAM_PREFIX, it is returned as-is,
+    #   assuming it is already properly escaped.
+    # @return [String] the filter to use in the URL, with FILTER_PARAM_PREFIX
+    ##############################################
     def self.parse_url_filter_param(filter)
       return filter if filter.nil? || filter.start_with?(FILTER_PARAM_PREFIX)
@@ -51,8 +59,6 @@ module Jamf
       defined?(self::FILTER_KEYS) ? self::FILTER_KEYS : []
     end
   end # Filterable
 end # Jamf

data/lib/jamf/api/jamf_pro/mixins/immutable.rb CHANGED Viewed

@@ -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
@@ -32,6 +32,7 @@ module Jamf
     def self.extended(extender)
       Jamf.load_msg "--> #{extender} is extending Jamf::Immutable"
     end
   end # Immutable
 end # Jamf

data/lib/jamf/api/jamf_pro/mixins/jpapi_resource.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -46,7 +46,15 @@ module Jamf
     API_SOURCE = :jamf_pro
     # These methods are allowed to call .new
-    NEW_CALLERS = ['fetch', 'create', 'all', 'cached_all', 'block in all', 'block in cached_all'].freeze
+    NEW_CALLERS = [
+      'fetch',
+      'create',
+      'all',
+      'cached_all',
+      'block in all',
+      'block in cached_all',
+      'block in page'
+    ].freeze
     # The resource version for previewing new features
     RSRC_PREVIEW_VERSION = 'preview'.freeze
@@ -67,14 +75,20 @@ module Jamf
       end
       # Disallow direct use of ruby's .new class method for creating instances.
-      # Require use of .fetch or .create, or 'all'
+      # Require use of a method in NEW_CALLERS, or the data must include
+      # :instantiate_me
+      #
+      # WARNING: do not abuse :instantiate_me, it exists so we don't constantly
+      # have to update NEW_CALLERS
       #
       def new(**data)
         calling_method = caller_locations(1..1).first.label
-        unless NEW_CALLERS.include? calling_method
+        unless NEW_CALLERS.include? calling_method || data[:instantiate_me]
           raise Jamf::UnsupportedError, 'Use .fetch, .create, or .all(instantiate:true) to instantiate Jamf::JPAPIResource objects'
         end
+        data.delete :instantiate_me
         super(**data)
       end
@@ -103,7 +117,6 @@ module Jamf
     #   When this gets set, it will contain the appropriate one.
     attr_reader :update_path
     # constructor
     #####################################
     def initialize(**data)

data/lib/jamf/api/jamf_pro/mixins/lockable.rb CHANGED Viewed

@@ -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
@@ -24,7 +24,7 @@
 module Jamf
-  # TODO may not be needed anymore
+  # TODO: may not be needed anymore
   # Classes mixing this in have a 'versionLock' attribute and implement
   # 'Optimistic Locking'

data/lib/jamf/api/jamf_pro/mixins/macos_managed_updates.rb CHANGED Viewed

@@ -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
@@ -24,6 +24,8 @@
 module Jamf
+  # @deprecated June 2025, Please use the {Jamf::ManagedSoftwareUpdates} module instead.
+  #
   # This module should be mixed in to Jamf::Computer and Jamf::ComputerGroup
   #
   # It provides access to the macos-managed-software-updates JPAPI resource for

data/lib/jamf/api/jamf_pro/mixins/macos_redeploy_mgmt_framework.rb CHANGED Viewed

@@ -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/jamf_pro/mixins/prestage.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -59,6 +59,9 @@ module Jamf
     # You Have Been Warned!
     NON_UNIQUE_IDENTIFIERS = %i[displayName].freeze
+    # The name of the attribute that holds the object's name
+    OBJECT_NAME_ATTR = :displayName
     # Class Methods
     #####################################
     module ClassMethods

data/lib/jamf/api/jamf_pro/mixins/sortable.rb CHANGED Viewed

@@ -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/jamf_pro/mixins/uncreatable.rb CHANGED Viewed

@@ -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/jamf_pro/mixins/undeletable.rb CHANGED Viewed

@@ -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/jamf_pro/oapi_schemas/account_group.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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/jamf_pro/oapi_schemas/account_preferences_v1.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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/jamf_pro/oapi_schemas/account_settings_request.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: AccountSettingsRequest
     #
     #
@@ -48,11 +46,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -64,10 +62,10 @@ module Jamf
       # Enums used by this class or others
-      USER_ACCOUNT_TYPE_OPTIONS = [
-        'ADMINISTRATOR',
-        'STANDARD',
-        'SKIP'
+      USER_ACCOUNT_TYPE_OPTIONS = %w[
+        ADMINISTRATOR
+        STANDARD
+        SKIP
       ]
       OAPI_PROPERTIES = {

data/lib/jamf/api/jamf_pro/oapi_schemas/account_settings_response.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: AccountSettingsResponse
     #
     #
@@ -48,11 +46,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -64,10 +62,10 @@ module Jamf
       # Enums used by this class or others
-      USER_ACCOUNT_TYPE_OPTIONS = [
-        'ADMINISTRATOR',
-        'STANDARD',
-        'SKIP'
+      USER_ACCOUNT_TYPE_OPTIONS = %w[
+        ADMINISTRATOR
+        STANDARD
+        SKIP
       ]
       OAPI_PROPERTIES = {

data/lib/jamf/api/jamf_pro/oapi_schemas/api_error.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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/jamf_pro/oapi_schemas/api_error_cause.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: ApiErrorCause
     #
     #
@@ -53,7 +51,7 @@ module Jamf
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -63,8 +61,6 @@ module Jamf
     #
     class ApiErrorCause < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # Error-specific code that can be used to identify localization string, etc.

data/lib/jamf/api/jamf_pro/oapi_schemas/api_integration_request.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: ApiIntegrationRequest
     #
     #
@@ -48,11 +46,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -65,8 +63,6 @@ module Jamf
     #
     class ApiIntegrationRequest < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # API Role display names.

data/lib/jamf/api/jamf_pro/oapi_schemas/api_integration_response.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: ApiIntegrationResponse
     #
     #
@@ -52,7 +50,7 @@ module Jamf
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -69,10 +67,10 @@ module Jamf
       # Enums used by this class or others
-      APP_TYPE_OPTIONS = [
-        'CLIENT_CREDENTIALS',
-        'NATIVE_APP_OAUTH',
-        'NONE'
+      APP_TYPE_OPTIONS = %w[
+        CLIENT_CREDENTIALS
+        NATIVE_APP_OAUTH
+        NONE
       ]
       OAPI_PROPERTIES = {

data/lib/jamf/api/jamf_pro/oapi_schemas/api_integration_search_result.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: ApiIntegrationSearchResult
     #
     #
@@ -48,7 +46,7 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
@@ -63,8 +61,6 @@ module Jamf
     #
     class ApiIntegrationSearchResult < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute [r] totalCount

data/lib/jamf/api/jamf_pro/oapi_schemas/api_role.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: ApiRole
     #
     #
@@ -52,7 +50,7 @@ module Jamf
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -67,8 +65,6 @@ module Jamf
     #
     class ApiRole < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute [r] id

data/lib/jamf/api/jamf_pro/oapi_schemas/api_role_request.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: ApiRoleRequest
     #
     #
@@ -48,11 +46,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -65,8 +63,6 @@ module Jamf
     #
     class ApiRoleRequest < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute displayName

data/lib/jamf/api/jamf_pro/oapi_schemas/api_role_result.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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/jamf_pro/oapi_schemas/assign_remove_profile_response_sync_state.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 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