ruby-jss 4.2.0b2 → 4.2.1

data/lib/jamf/api/jamf_pro/mixins/filterable.rb

@@ -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)
 

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

@@ -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
 

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

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

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

@@ -0,0 +1,123 @@
+# 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
+#    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
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: AccountGroup
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::Authorization
+    #  - Jamf::OAPISchemas::AuthorizationV1
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class AccountGroup < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      ACCESS_LEVEL_OPTIONS = [
+        'FullAccess',
+        'SiteAccess',
+        'GroupBasedAccess'
+      ]
+
+      PRIVILEGE_SET_OPTIONS = [
+        'ADMINISTRATOR',
+        'AUDITOR',
+        'ENROLLMENT',
+        'CUSTOM'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute accessLevel
+        #   @return [String]
+        accessLevel: {
+          class: :string,
+          enum: ACCESS_LEVEL_OPTIONS
+        },
+
+        # @!attribute privilegeSet
+        #   @return [String]
+        privilegeSet: {
+          class: :string,
+          enum: PRIVILEGE_SET_OPTIONS
+        },
+
+        # @!attribute siteId
+        #   @return [Integer]
+        siteId: {
+          class: :integer
+        },
+
+        # @!attribute privileges
+        #   @return [Array<String>]
+        privileges: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute memberUserIds
+        #   @return [Array<Integer>]
+        memberUserIds: {
+          class: :integer,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class AccountGroup
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/account_preferences_v1.rb

@@ -0,0 +1,105 @@
+# 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
+#    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
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: AccountPreferencesV1
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::AuthAccountV1
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class AccountPreferencesV1 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute language
+        #   @return [String]
+        language: {
+          class: :string
+        },
+
+        # @!attribute dateFormat
+        #   @return [String]
+        dateFormat: {
+          class: :string
+        },
+
+        # @!attribute region
+        #   @return [String]
+        region: {
+          class: :string
+        },
+
+        # @!attribute timezone
+        #   @return [String]
+        timezone: {
+          class: :string
+        },
+
+        # @!attribute disableRelativeDates
+        #   @return [Boolean]
+        disableRelativeDates: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class AccountPreferencesV1
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/assign_remove_profile_response_sync_state.rb

@@ -0,0 +1,112 @@
+# 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
+#    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
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: AssignRemoveProfileResponseSyncState
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::DeviceEnrollmentDevice
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class AssignRemoveProfileResponseSyncState < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute serialNumber
+        #   @return [String]
+        serialNumber: {
+          class: :string
+        },
+
+        # @!attribute profileUUID
+        #   @return [String]
+        profileUUID: {
+          class: :string
+        },
+
+        # @!attribute syncStatus
+        #   @return [String]
+        syncStatus: {
+          class: :string
+        },
+
+        # @!attribute failureCount
+        #   @return [Integer]
+        failureCount: {
+          class: :integer
+        },
+
+        # @!attribute timestamp
+        #   @return [Integer]
+        timestamp: {
+          class: :integer
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class AssignRemoveProfileResponseSyncState
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/auth_account_v1.rb

@@ -0,0 +1,159 @@
+# 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
+#    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
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: AuthAccountV1
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::AuthorizationV1
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  - Jamf::OAPISchemas::AccountPreferencesV1
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class AuthAccountV1 < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      ACCESS_LEVEL_OPTIONS = [
+        'FullAccess',
+        'SiteAccess',
+        'GroupBasedAccess'
+      ]
+
+      PRIVILEGE_SET_OPTIONS = [
+        'ADMINISTRATOR',
+        'AUDITOR',
+        'ENROLLMENT',
+        'CUSTOM'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          min_length: 1
+        },
+
+        # @!attribute username
+        #   @return [String]
+        username: {
+          class: :string
+        },
+
+        # @!attribute realName
+        #   @return [String]
+        realName: {
+          class: :string
+        },
+
+        # @!attribute email
+        #   @return [String]
+        email: {
+          class: :string
+        },
+
+        # @!attribute preferences
+        #   @return [Jamf::OAPISchemas::AccountPreferencesV1]
+        preferences: {
+          class: Jamf::OAPISchemas::AccountPreferencesV1
+        },
+
+        # @!attribute multiSiteAdmin
+        #   @return [Boolean]
+        multiSiteAdmin: {
+          class: :boolean
+        },
+
+        # @!attribute accessLevel
+        #   @return [String]
+        accessLevel: {
+          class: :string,
+          enum: ACCESS_LEVEL_OPTIONS
+        },
+
+        # @!attribute privilegeSet
+        #   @return [String]
+        privilegeSet: {
+          class: :string,
+          enum: PRIVILEGE_SET_OPTIONS
+        },
+
+        # @!attribute privilegesBySite
+        #   @return [Hash{Symbol: Array<String> }]
+        privilegesBySite: {
+          class: :hash
+        },
+
+        # @!attribute groupIds
+        #   @return [Array<String>]
+        groupIds: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute currentSiteId
+        #   @return [String]
+        currentSiteId: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class AuthAccountV1
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/authentication_type.rb

@@ -0,0 +1,97 @@
+# 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
+#    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
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: AuthenticationType
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::Authorization
+    #  - Jamf::OAPISchemas::AuthorizationV1
+    #  - Jamf::OAPISchemas::CurrentAuthorization
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class AuthenticationType < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      VALUE_OPTIONS = [
+        'JSS',
+        'LDAP',
+        'SAML',
+        'INVITE',
+        'NATIVE_APP_API_INTEGRATION',
+        'DEVICE_SIGNATURE',
+        'CLOUD_CONNECTOR',
+        'SYSTEM_ACCOUNT',
+        'USER_ENROLLMENT',
+        'CLIENT_CREDENTIALS'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute value
+        #   @return [String]
+        value: {
+          class: :string,
+          enum: VALUE_OPTIONS
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class AuthenticationType
+
+  end # module OAPISchemas
+
+end # module Jamf