ruby-jss 1.4.1 → 1.5.1

data/lib/jamf/api/resources/collection_resources/device_enrollment.rb

@@ -61,9 +61,9 @@ module Jamf
     OBJECT_MODEL = {
 
       # @!attribute id
-      #   @return [Integer]
+      #   @return [String]
       id: {
-        class: :integer,
+        class: :j_id,
         identifier: :primary,
         readonly: true
       },
@@ -76,15 +76,15 @@ module Jamf
       },
 
       # @!attribute supervisionIdentityId
-      #   @return [Integer]
+      #   @return [String]
       supervisionIdentityId: {
-        class: :integer
+        class: :j_id
       },
 
       # @!attribute siteId
-      #   @return [Integer]
+      #   @return [String]
       siteId: {
-        class: :integer
+        class: :j_id
       },
 
       # @!attribute serverName
@@ -293,14 +293,14 @@ module Jamf
 
     # disown one or more serial numbers from a given DeviceEnrollment instance
     #
-    # @param sns[Array<String>] One or more serial numbers to disown
+    # @param sns[String, Array<String>] One or more serial numbers to disown
     #
     # @param from_instance [Integer, String] the id or name of the instance
     #  from which to disown the serial numbers
     #
     # @param cnx[Jamf::Connection] The API connection to use
     #
-    # @return [void]
+    # @return [Hash] The SNs as keys and 'SUCESS' or 'FAILED' as values
     #
     def self.disown(*sns, from_instance:, cnx: Jamf.cnx)
       instance_id = valid_id from_instance, cnx: cnx
@@ -311,14 +311,14 @@ module Jamf
       data = { devices: sns }
       disown_rsrc = "#{self.class::RSRC_VERSION}/#{self.class::RSRC_PATH}/#{instance_id}/#{DISOWN_RSRC}"
 
-      cnx.post(disown_rsrc, data)
+      cnx.post(disown_rsrc, data)[:devices]
     end
 
     # Private Class Methods
     ###############################################
 
     # Private, used by the .devices class method
-    def self.fetch_devices(instance_ident, refresh, cnx)
+    def self.fetch_devices(instance_ident = nil, refresh, cnx)
       if instance_ident
         instance_id = valid_id instance_ident, cnx: cnx
         raise Jamf::NoSuchItemError, "No DeviceEnrollment instance matches '#{instance_ident}'" unless instance_id

data/lib/jamf/api/resources/collection_resources/inventory_preload_record.rb

@@ -51,9 +51,11 @@ module Jamf
     # Constants
     #####################################
 
-    RSRC_VERSION = 'v1'.freeze
+    RSRC_VERSION = 'v2'.freeze
 
-    RSRC_PATH = 'inventory-preload'.freeze
+    RSRC_PATH = 'inventory-preload/records'.freeze
+
+    CHANGE_LOG_RSRC = "#{RSRC_VERSION}/inventory-preload/history".freeze
 
     DEVICE_TYPE_COMPUTER = 'Computer'.freeze
     DEVICE_TYPE_MOBILE_DEV = 'Mobile Device'.freeze
@@ -77,7 +79,7 @@ module Jamf
       # @!attribute [r] id
       #   @return [Integer]
       id: {
-        class: :integer,
+        class: :j_id,
         identifier: :primary,
         readonly: true
       },
@@ -219,6 +221,12 @@ module Jamf
         class: :string
       },
 
+      # @!attribute vendor
+      #   @return [String]
+      vendor: {
+        class: :string
+      },
+
       # @!attribute extensionAttributes
       #   @return [Jamf::InventoryPreloadExtensionAttribute]
       extensionAttributes: {

data/lib/jamf/api/resources/collection_resources/mobile_device_prestage.rb

@@ -37,7 +37,7 @@ module Jamf
     # Constants
     #####################################
 
-    RSRC_VERSION = 'v1'.freeze
+    RSRC_VERSION = 'v2'.freeze
 
     RSRC_PATH = 'mobile-device-prestages'.freeze
 
@@ -53,21 +53,21 @@ module Jamf
         class: Jamf::MobileDevicePrestageSkipSetupItems
       },
 
-      # @!attribute isAllowPairing
+      # @!attribute allowPairing
       #   @return [Boolean]
-      isAllowPairing: {
+      allowPairing: {
         class: :boolean
       },
 
-      # @!attribute isMultiUser
+      # @!attribute multiUser
       #   @return [Boolean]
-      isMultiUser: {
+      multiUser: {
         class: :boolean
       },
 
-      # @!attribute isSupervised
+      # @!attribute supervised
       #   @return [Boolean]
-      isSupervised: {
+      supervised: {
         class: :boolean
       },
 
@@ -79,33 +79,35 @@ module Jamf
 
       # @!attribute isAutoAdvanceSetup
       #   @return [Boolean]
-      isAutoAdvanceSetup: {
+      autoAdvanceSetup: {
         class: :boolean
       },
 
-      # @!attribute isConfigureDeviceBeforeSetupAssistant
+      # @!attribute configureDeviceBeforeSetupAssistant
       #   @return [Boolean]
-      isConfigureDeviceBeforeSetupAssistant: {
+      configureDeviceBeforeSetupAssistant: {
         class: :boolean
       },
 
-      # @!attribute language
-      #   @return [String]
-      language: {
-        class: :string
-      },
-
-      # @!attribute region
-      #   @return [String]
-      region: {
-        class: :string
-      },
-
       # @!attribute names
       #   @return [Jamf::MobileDevicePrestageNames]
       names: {
         class: Jamf::MobileDevicePrestageNames
+      },
+
+      # @!attribute sendTimezone
+      #   @return [Boolean]
+      sendTimezone: {
+        class: :boolean
+      },
+
+      # @!attribute timezone
+      #   @return [String]
+      timezone: {
+        class: :string
       }
+
+
     ).freeze
 
     parse_object_model

data/lib/jamf/api/resources/collection_resources/script.rb

@@ -41,9 +41,8 @@ module Jamf
     # Constants
     #####################################
 
-    RSRC_PATH = 'scripts'.freeze
-
     RSRC_VERSION = 'v1'.freeze
+    RSRC_PATH = 'scripts'.freeze
 
     PRIORITY_BEFORE = 'BEFORE'.freeze
     PRIORITY_AFTER = 'AFTER'.freeze
@@ -64,35 +63,40 @@ module Jamf
       # @!attribute [r] id
       #   @return [Integer]
       id: {
-        class: :integer,
+        class: :j_id,
         identifier: :primary,
-        readonly: true
+        readonly: true,
+        filter_key: true
       },
 
       # @!attribute name
       #   @return [String]
       name: {
         class: :string,
-        identifier: true
+        identifier: true,
+        filter_key: true
       },
 
       # @!attribute info
       #   @return [String]
       info: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute notes
       #   @return [String]
       notes: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute priority
       #   @return [String]
       priority: {
         class: :string,
-        enum: Jamf::Script::PRIORTIES
+        enum: Jamf::Script::PRIORTIES,
+        filter_key: true
       },
 
       # TODO: Jamf should standardize object references
@@ -101,19 +105,22 @@ module Jamf
       # @!attribute categoryId
       #   @return [Integer]
       categoryId: {
-        class: :integer
+        class: :j_id,
+        filter_key: true
       },
 
       # @!attribute categoryName
       #   @return [String]
       categoryName: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute osRequirements
       #   @return [String]
       osRequirements: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute scriptContents
@@ -121,68 +128,97 @@ module Jamf
       scriptContents: {
         class: :string,
         validate: :script_contents,
-        aliases: %i[code]
+        aliases: %i[code],
+        filter_key: true
       },
 
       # @!attribute parameter4
       #   @return [String]
       parameter4: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute parameter5
       #   @return [String]
       parameter5: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute parameter6
       #   @return [String]
       parameter6: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute parameter7
       #   @return [String]
       parameter7: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute parameter8
       #   @return [String]
       parameter8: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute parameter9
       #   @return [String]
       parameter9: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute parameter10
       #   @return [String]
       parameter10: {
-        class: :string
+        class: :string,
+        filter_key: true
       },
 
       # @!attribute parameter11
       #   @return [String]
       parameter11: {
-        class: :string
+        class: :string,
+        filter_key: true
       }
     }.freeze
 
     parse_object_model
 
-
     # Class Methods
     ##################################
 
-    def self.scriptContents(scr_ident, cnx: Jamf.cnx)
-      id = valid_id scr_ident
-      raise Jamf::NoSuchItemError, "No script matches '#{scr_ident}'" unless id
-      cnx.download "#{RSRC_VERSION}/#{RSRC_PATH}/#{id}/download"
+    # Retrieve a script's code without instantiating
+    #
+    # Specify an ident key, either id: or name: and the
+    # value for that ident
+    # e.g. `download id: 123`  or `download name: 'myscript'`
+    #
+    # @param cnx [Jamf::Connection] The connection to use, default: Jamf.cnx
+    #
+    # @return [String] The code of the desired script
+    #
+    def self.download(cnx: Jamf.cnx, **ident_and_val)
+      ident, value = ident_and_val.first
+      if ident == :id
+        begin
+          return cnx.download "#{rsrc_path}/#{value}/download"
+        rescue => e
+          raise Jamf::NoSuchItemError, "No script with #{ident} = #{value}" if e.httpStatus == 404
+
+          raise e
+        end # begin
+      end # if
+      id = raw_data(cnx: cnx, **ident_and_val)&.dig(:id)
+      raise Jamf::NoSuchItemError, "No script with #{ident} = #{value}" unless id
+
+      cnx.download "#{rsrc_path}/#{id}/download"
     end
 
   end # class

data/lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb

@@ -32,6 +32,9 @@ module Jamf
   #
   class AppStoreCountryCodes < Jamf::SingletonResource
 
+    # Mix-Ins
+    #####################################
+
     extend Jamf::Immutable
 
     # Constants
@@ -48,7 +51,8 @@ module Jamf
       countryCodes: {
         class: Jamf::Country,
         multi: true,
-        read_only: true
+        read_only: true,
+        aliases: [:list]
       }
 
     }.freeze # end OBJECT_MODEL
@@ -58,6 +62,12 @@ module Jamf
     # Class Methods
     #####################################
 
+    # @return [Array<Jamf::Country>] all the Countries available
+    #
+    def self.list(refresh = false, cnx: Jamf.cnx)
+      fetch(refresh, cnx: cnx).countryCodes
+    end
+
     # Class level wrapper for #names
     def self.names(refresh = false, cnx: Jamf.cnx)
       fetch(refresh, cnx: cnx).names
@@ -93,22 +103,22 @@ module Jamf
 
     # @return [Array<String>] the available country names
     def names
-      @names ||= countryCodes.map{ |country| country.name }
+      @names ||= countryCodes.map(&:name)
     end
 
     # @return [Array<String>] the available country codes
     def codes
-      @codes ||= countryCodes.map{ |country| country.code }
+      @codes ||= countryCodes.map(&:code)
     end
 
     # @return [Hash] name => code
     def codes_by_name
-      @codes_by_name ||= countryCodes.map{ |country| [country.name, country.code] }.to_h
+      @codes_by_name ||= countryCodes.map { |country| [country.name, country.code] }.to_h
     end
 
     # @return [Hash] code => name
     def names_by_code
-      @names_by_code ||= countryCodes.map{ |country| [country.code, country.name] }.to_h
+      @names_by_code ||= countryCodes.map { |country| [country.code, country.name] }.to_h
     end
 
     # return a country code from its name, case-insensitive

data/lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb

@@ -40,7 +40,7 @@ module Jamf
 
     UPDATABLE = true
 
-    RSRC_VERSION = 'v1'.freeze
+    RSRC_VERSION = 'v2'.freeze
 
     RSRC_PATH = 'check-in'.freeze
 
@@ -54,79 +54,79 @@ module Jamf
 
       # @!attribute isCreateHooks
       #   @return [Boolean]
-      isCreateHooks: {
+      createHooks: {
         class: :boolean
       },
 
       # @!attribute isHookLog
       #   @return [Boolean]
-      isHookLog: {
+      hookLog: {
         class: :boolean
       },
 
       # @!attribute isHookPolicies
       #   @return [Boolean]
-      isHookPolicies: {
+      hookPolicies: {
         class: :boolean
       },
 
       # @!attribute isHookHideRestore
       #   @return [Boolean]
-      isHookHideRestore: {
+      hookHideRestore: {
         class: :boolean
       },
 
       # @!attribute isHookMCX
       #   @return [Boolean]
-      isHookMCX: {
+      hookMcx: {
         class: :boolean
       },
 
       # @!attribute isBackgroundHooks
       #   @return [Boolean]
-      isBackgroundHooks: {
+      backgroundHooks: {
         class: :boolean
       },
 
       # @!attribute isHookDisplayStatus
       #   @return [Boolean]
-      isHookDisplayStatus: {
+      hookDisplayStatus: {
         class: :boolean
       },
 
       # @!attribute isCreateStartupScript
       #   @return [Boolean]
-      isCreateStartupScript: {
+      createStartupScript: {
         class: :boolean
       },
 
       # @!attribute isStartupLog
       #   @return [Boolean]
-      isStartupLog: {
+      startupLog: {
         class: :boolean
       },
 
       # @!attribute isStartupPolicies
       #   @return [Boolean]
-      isStartupPolicies: {
+      startupPolicies: {
         class: :boolean
       },
 
       # @!attribute isStartupSSH
       #   @return [Boolean]
-      isStartupSSH: {
+      startupSsh: {
         class: :boolean
       },
 
       # @!attribute isStartupMCX
       #   @return [Boolean]
-      isStartupMCX: {
+      startupMcx: {
         class: :boolean
       },
 
       # @!attribute isEnableLocalConfigurationProfiles
       #   @return [Boolean]
-      isEnableLocalConfigurationProfiles: {
+      enableLocalConfigurationProfiles: {
         class: :boolean
       }