ruby-jss 4.2.2 → 4.2.4b1

data/lib/jamf/api/classic/api_objects/directory_binding_type/open_directory.rb

@@ -1,178 +1,151 @@
-### Copyright 2019 Rixar
-
-###
-###    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.
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
 ###
 ###
 
 module Jamf
 
-    # Module for containing the different types of DirectoryBindings stored within the JSS
-
-    module DirectoryBindingType
-
-        # Module Variables
-        #####################################
-
-        # Module Methods
-        #####################################
-
-        # Classes
-        #####################################
-
-        # Class for the specific OpenDirectory DirectoryBinding type stored within the JSS
-        #
-        # @author Tyler Morgan
-        #
-        # Attributes
-        # @!attribute [rw] require_confirmation
-
-        class OpenDirectory < DirectoryBindingType
-            # Mix-Ins
-            #####################################
-
-            # Class Methods
-            #####################################
-
-            # Class Constants
-            #####################################
-
-            # Attributes
-            #####################################
-            attr_reader :encrypt_using_ssl
-            attr_reader :perform_secure_bind
-            attr_reader :use_for_authentication
-            attr_reader :use_for_contacts
-
-            # Constructor
-            #####################################
-            def initialize(init_data)
-
-                # Return without processing anything since there is
-                # nothing to process.
-                return if init_data.nil?
-
-                # Process the provided information
-                @encrypt_using_ssl = init_data[:encrypt_using_ssl]
-                @perform_secure_bind = init_data[:perform_secure_bind]
-                @use_for_authentication = init_data[:use_for_authentication]
-                @use_for_contacts = init_data[:use_for_contacts]
-            end
-
-
-
-            # Public Instance Methods
-            #####################################
-
-            # Encrypt the connection using SSL
-            #
-            # @author Tyler Morgan
-            #
-            # @param newvalue [Bool]
-            #
-            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
-            #
-            # @return [void]
-            def encrypt_using_ssl=(newvalue)
-
-                raise Jamf::InvalidDataError, "encrypt_using_ssl must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
-
-                @encrypt_using_ssl = newvalue
-
-                self.container&.should_update
-            end
-
-
-            # Attempt to perform a secure bind to the domain server
-            #
-            # @author Tyler Morgan
-            #
-            # @param newvalue [Bool]
-            #
-            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
-            #
-            # @return [void]
-            def perform_secure_bind=(newvalue)
-
-                raise Jamf::InvalidDataError, "perform_secure_bind must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
-
-                @perform_secure_bind = newvalue
-
-                self.container&.should_update
-            end
+  # Module for containing the different types of DirectoryBindings stored within the JSS
+
+  module DirectoryBindingType
+
+    # Module Variables
+    #####################################
+
+    # Module Methods
+    #####################################
+
+    # Classes
+    #####################################
+
+    # Class for the specific OpenDirectory DirectoryBinding type stored within the JSS
+    #
+    # @author Tyler Morgan
+    #
+    # Attributes
+    # @!attribute [rw] require_confirmation
+
+    class OpenDirectory < DirectoryBindingType
+
+      # Mix-Ins
+      #####################################
+
+      # Class Methods
+      #####################################
+
+      # Class Constants
+      #####################################
+
+      # Attributes
+      #####################################
+      attr_reader :encrypt_using_ssl
+      attr_reader :perform_secure_bind, :use_for_authentication, :use_for_contacts
+
+      # Constructor
+      #####################################
+      def initialize(init_data)
+        # Return without processing anything since there is
+        # nothing to process.
+        return if init_data.nil?
+
+        # Process the provided information
+        @encrypt_using_ssl = init_data[:encrypt_using_ssl]
+        @perform_secure_bind = init_data[:perform_secure_bind]
+        @use_for_authentication = init_data[:use_for_authentication]
+        @use_for_contacts = init_data[:use_for_contacts]
+      end
+
+      # Public Instance Methods
+      #####################################
+
+      # Encrypt the connection using SSL
+      #
+      # @author Tyler Morgan
+      #
+      # @param newvalue [Bool]
+      #
+      # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
+      #
+      # @return [void]
+      def encrypt_using_ssl=(newvalue)
+        raise Jamf::InvalidDataError, 'encrypt_using_ssl must be true or false.' unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+
+        @encrypt_using_ssl = newvalue
+
+        container&.should_update
+      end
+
+      # Attempt to perform a secure bind to the domain server
+      #
+      # @author Tyler Morgan
+      #
+      # @param newvalue [Bool]
+      #
+      # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
+      #
+      # @return [void]
+      def perform_secure_bind=(newvalue)
+        raise Jamf::InvalidDataError, 'perform_secure_bind must be true or false.' unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+
+        @perform_secure_bind = newvalue
+
+        container&.should_update
+      end
+
+      # Use this binding for authentication
+      #
+      # @author Tyler Morgan
+      #
+      # @param newvalue [Bool]
+      #
+      # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
+      #
+      # @return [void]
+      def use_for_authentication=(newvalue)
+        raise Jamf::InvalidDataError, 'use_for_authentication must be true or false.' unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+
+        @use_for_authentication = newvalue
+
+        container&.should_update
+      end
+
+      # Use this binding for contact population
+      #
+      # @author Tyler Morgan
+      #
+      # @param newvalue [Bool]
+      #
+      # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
+      #
+      # @return [void]
+      def use_for_contacts=(newvalue)
+        raise Jamf::InvalidDataError, 'use_for_contacts must be true or false.' unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+
+        @use_for_contacts = newvalue
+
+        container&.should_update
+      end
+
+      # Return a REXML Element containing the current state of the DirectoryBindingType
+      # object for adding into the XML of the container.
+      #
+      # @author Tyler Morgan
+      #
+      # @return [REXML::Element]
+      def type_setting_xml
+        type_setting = REXML::Element.new 'admitmac'
+        type_setting.add_element('encrypt_using_ssl').text = @encrypt_using_ssl
+        type_setting.add_element('perform_secure_bind').text = @perform_secure_bind
+        type_setting.add_element('use_for_authentication').text = @use_for_authentication
+        type_setting.add_element('use_for_contacts').text = @use_for_contacts
+
+        type_setting
+      end
 
+    end
 
-            # Use this binding for authentication
-            #
-            # @author Tyler Morgan
-            #
-            # @param newvalue [Bool]
-            #
-            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
-            #
-            # @return [void]
-            def use_for_authentication=(newvalue)
-
-                raise Jamf::InvalidDataError, "use_for_authentication must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
-
-                @use_for_authentication = newvalue
-
-                self.container&.should_update
-            end
-
-
-            # Use this binding for contact population
-            #
-            # @author Tyler Morgan
-            #
-            # @param newvalue [Bool]
-            #
-            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
-            #
-            # @return [void]
-            def use_for_contacts=(newvalue)
-
-                raise Jamf::InvalidDataError, "use_for_contacts must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+  end
 
-                @use_for_contacts = newvalue
-
-                self.container&.should_update
-            end
-
-
-            # Return a REXML Element containing the current state of the DirectoryBindingType
-            # object for adding into the XML of the container.
-            #
-            # @author Tyler Morgan
-            #
-            # @return [REXML::Element]
-            def type_setting_xml
-                type_setting = REXML::Element.new "admitmac"
-                type_setting.add_element("encrypt_using_ssl").text = @encrypt_using_ssl
-                type_setting.add_element("perform_secure_bind").text = @perform_secure_bind
-                type_setting.add_element("use_for_authentication").text = @use_for_authentication
-                type_setting.add_element("use_for_contacts").text = @use_for_contacts
-
-                return type_setting
-            end
-        end
-    end
 end

data/lib/jamf/api/classic/api_objects/directory_binding_type/powerbroker_identity_services.rb

@@ -1,73 +1,53 @@
-### Copyright 2019 Rixar
-
-###
-###    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.
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
 ###
 ###
 
 module Jamf
 
-    # Module for containing the different types of DirectoryBindings stored within the JSS
-    
-    module DirectoryBindingType
+  # Module for containing the different types of DirectoryBindings stored within the JSS
+
+  module DirectoryBindingType
+
+    # Module Variables
+    #####################################
 
-        # Module Variables
-        #####################################
+    # Module Methods
+    #####################################
 
-        # Module Methods
-        #####################################
+    # Classes
+    #####################################
 
-        # Classes
-        #####################################
+    # Class for the specific PowerBroker DirectoryBinding type stored within the JSS
+    #
+    # @author Tyler Morgan
+    #
+    # Attributes
+    class PowerBroker < DirectoryBindingType
 
-        # Class for the specific PowerBroker DirectoryBinding type stored within the JSS
-        # 
-        # @author Tyler Morgan
-        #
-        # Attributes
-        class PowerBroker < DirectoryBindingType
-            # Mix-Ins
-            #####################################
+      # Mix-Ins
+      #####################################
 
-            
-            # Class Methods
-            #####################################
+      # Class Methods
+      #####################################
 
-            
-            # Class Constants
-            #####################################
+      # Class Constants
+      #####################################
 
-            
-            # Attributes
-            #####################################
+      # Attributes
+      #####################################
 
-            
-            # Constructor
-            #####################################
-            def initialize(init_data)
-            end
+      # Constructor
+      #####################################
+      def initialize(init_data); end
 
+      # Public Instance Methods
+      #####################################
 
-            # Public Instance Methods
-            #####################################
-        end
     end
-end
+
+  end
+
+end

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

@@ -1,25 +1,7 @@
-### Copyright 2019 Rixar
-
-###
-###    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.
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
 ###
 ###
 

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

@@ -1,114 +1,120 @@
 module Jamf
-    ### Module Constants
-    #####################################
 
-    ### Module Variables
-    #####################################
+  ### Module Constants
+  #####################################
 
-    ### Module Methods
-    #####################################
+  ### Module Variables
+  #####################################
 
-    ### Classes
-    #####################################
+  ### Module Methods
+  #####################################
 
-    ### Disk Encryption Configuration object inside JSS
-    ###
-    ### More Detailed Description if needed
-    class DiskEncryptionConfiguration < Jamf::APIObject
-        ## Mix-Ins
-        #####################################
-        include Jamf::Updatable
+  ### Classes
+  #####################################
 
-        ## Class Constants
-        #####################################
+  ### Disk Encryption Configuration object inside JSS
+  ###
+  ### More Detailed Description if needed
+  class DiskEncryptionConfiguration < Jamf::APIObject
 
-        # @note Currently "Individual and Institutional" configuration type is unsupported through the API
-        KEY_TYPE = {
-            individual: 'Individual',
-            institutional: 'Institutional',
-            individual_and_institutional: 'Individual and Institutional'
-        }.freeze
-
-        # @note as of 10.13 Management Account cannot be used due to the lack of a secure token.
-        ENABLED_USERS_TYPE = {
-            management: "Management Account",
-            current: "Current or Next User"
-        }.freeze
-
-        ### The base for REST resources of this class
-        RSRC_BASE = 'diskencryptionconfigurations'.freeze
+    ## Mix-Ins
+    #####################################
+    include Jamf::Updatable
 
-        ### the hash key used for the JSON list output of all objects in the JSS
-        RSRC_LIST_KEY = :disk_encryption_configurations
+    ## Class Constants
+    #####################################
 
-        ### The hash key used for the JSON object output
-        ### It's also used in various error messages
-        RSRC_OBJECT_KEY = :disk_encryption_configuration
+    # @note Currently "Individual and Institutional" configuration type is unsupported through the API
+    KEY_TYPE = {
+      individual: 'Individual',
+      institutional: 'Institutional',
+      individual_and_institutional: 'Individual and Institutional'
+    }.freeze
 
-        ## Attributes
-        #####################################
-        attr_reader :key_type
-        attr_reader :file_vault_enabled_users
-        attr_reader :institutional_recovery_key
+    # @note as of 10.13 Management Account cannot be used due to the lack of a secure token.
+    ENABLED_USERS_TYPE = {
+      management: 'Management Account',
+      current: 'Current or Next User'
+    }.freeze
 
-        ## Constructor
-        #####################################
+    ### The base for REST resources of this class
+    RSRC_BASE = 'diskencryptionconfigurations'.freeze
 
-        ###
-        def initialize(**args)
-            super
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :disk_encryption_configurations
 
-            if self.in_jss?
-                @key_type = @init_data[:key_type]
-                @file_vault_enabled_users = @init_data[:file_vault_enabled_users]
-                @institutional_recovery_key = @init_data[:institutional_recovery_key]
-            else
-                raise Jamf::InvalidDataError, "Currently the ability to create a Disk Encryption Configuration is not possible through ruby-jss."
-            end
+    ### The hash key used for the JSON object output
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :disk_encryption_configuration
 
+    ## Attributes
+    #####################################
+    attr_reader :key_type
+    attr_reader :file_vault_enabled_users, :institutional_recovery_key
 
+    ## Constructor
+    #####################################
 
-        end
+    ###
+    def initialize(**args)
+      super
 
-        ## Class Methods
-        #####################################
+      raise Jamf::InvalidDataError, 'Currently the ability to create a Disk Encryption Configuration is not possible through ruby-jss.' unless in_jss?
 
-        # Sets what type of account is to be enabled using the new value
-        #
-        # @author Tyler Morgan
-        #
-        # @param newvalue[Symbol] One of ENABLED_USERS_TYPE
-        #
-        # @return [Void]
-        #
-        def file_vault_enabled_users=(newvalue)
-            raise Jamf::InvalidDataError, "file_vault_enabled_users must be one of :#{ENABLED_USERS_TYPE.keys.join(',:')}." unless ENABLED_USERS_TYPE.keys.include? newvalue
+      @key_type = @init_data[:key_type]
+      @file_vault_enabled_users = @init_data[:file_vault_enabled_users]
+      @institutional_recovery_key = @init_data[:institutional_recovery_key]
+        
+            
+        
+    end
 
-            @file_vault_enabled_users = ENABLED_USERS_TYPE[newvalue]
+    ## Class Methods
+    #####################################
 
-            @need_to_update = true
+    # Sets what type of account is to be enabled using the new value
+    #
+    # @author Tyler Morgan
+    #
+    # @param newvalue[Symbol] One of ENABLED_USERS_TYPE
+    #
+    # @return [Void]
+    #
+    def file_vault_enabled_users=(newvalue)
+      unless ENABLED_USERS_TYPE.keys.include? newvalue
+        raise Jamf::InvalidDataError, 
+              "file_vault_enabled_users must be one of :#{ENABLED_USERS_TYPE.keys.join(',:')}."
+      end
+
+      @file_vault_enabled_users = ENABLED_USERS_TYPE[newvalue]
+
+      @need_to_update = true
+    end
 
-        end
+    ## Private Instance Methods
+    #####################################
 
-        ## Private Instance Methods
-        #####################################
+    private
 
-        private
+    def rest_xml
+      if @key_type == KEY_TYPE[:individual_and_institutional]
+        raise Jamf::UnsupportedError, 
+              'Key type of "Individual and Institutional" is currently unsupported via. API. So changes are unable to be saved.'
+      end
 
-        def rest_xml
-            raise Jamf::UnsupportedError, "Key type of \"Individual and Institutional\" is currently unsupported via. API. So changes are unable to be saved." if @key_type == KEY_TYPE[:individual_and_institutional]
-            doc = REXML::Document.new
-            disk_encryption_configuration = doc.add_element 'disk_encryption_configuration'
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
+      doc.root.name = 'disk_encryption_configuration'
 
-            disk_encryption_configuration.add_element('id').text = @id
-            disk_encryption_configuration.add_element('name').text = @name
-            disk_encryption_configuration.add_element('key_type').text = @key_type
-            disk_encryption_configuration.add_element('file_vault_enabled_users').text = @file_vault_enabled_users
+      disk_encryption_configuration = doc.root
 
-            doc.to_s
+      disk_encryption_configuration.add_element('id').text = @id
+      disk_encryption_configuration.add_element('name').text = @name
+      disk_encryption_configuration.add_element('key_type').text = @key_type
+      disk_encryption_configuration.add_element('file_vault_enabled_users').text = @file_vault_enabled_users
 
+      doc.to_s
+    end
 
+  end
 
-        end
-    end
 end