ruby-jss 1.6.4 → 2.0.0b1

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

@@ -1,143 +0,0 @@
-# Copyright 2020 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.
-#
-#
-
-# The Module
-module Jamf
-
-  # Classes
-  #####################################
-
-  # A building defined in the JSS
-  class MobileDevicePrestage < Jamf::Prestage
-
-    include Jamf::ChangeLog
-
-    # Constants
-    #####################################
-
-    RSRC_VERSION = 'v2'.freeze
-
-    RSRC_PATH = 'mobile-device-prestages'.freeze
-
-    # Object Model / Attributes
-    # See APIObject class documentation for details
-    # of how the OBJECT_MODEL hash works.
-    #####################################
-    OBJECT_MODEL = superclass::OBJECT_MODEL.merge(
-
-      # @!attribute skipSetupItems
-      #   @return [Jamf::ComputerPrestageSkipSetupItems]
-      skipSetupItems: {
-        class: :hash
-      },
-
-      # @!attribute allowPairing
-      #   @return [Boolean]
-      allowPairing: {
-        class: :boolean
-      },
-
-      # @!attribute multiUser
-      #   @return [Boolean]
-      multiUser: {
-        class: :boolean
-      },
-
-      # @!attribute supervised
-      #   @return [Boolean]
-      supervised: {
-        class: :boolean
-      },
-
-      # @!attribute maximumSharedAccounts
-      #   @return [Integer]
-      maximumSharedAccounts: {
-        class: :integer
-      },
-
-      # @!attribute isAutoAdvanceSetup
-      #   @return [Boolean]
-      autoAdvanceSetup: {
-        class: :boolean
-      },
-
-      # @!attribute configureDeviceBeforeSetupAssistant
-      #   @return [Boolean]
-      configureDeviceBeforeSetupAssistant: {
-        class: :boolean
-      },
-
-      # @!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
-
-    # Class Methods
-    ###############################################
-
-    def self.sync_status(prestage = nil, latest = false, cnx: Jamf.cnx)
-      @sync_rsrc ||= "#{self::RSRC_VERSION}/#{self::RSRC_PATH}/#{SYNC_RSRC}"
-
-      if prestage
-        id = valid_id prestage
-        raise Jamf::NoSuchItemError, "No #{self.class} matching '#{prestage}'" unless id
-
-        rsrc = "#{@sync_rsrc}/#{id}"
-        rsrc << '/latest' if latest
-        results = cnx.get rsrc
-        latest ? Jamf::PrestageSyncStatus.new(results) : results.map { |ss| Jamf::PrestageSyncStatus.new ss }
-      else
-        cnx.get(@sync_rsrc).map { |ss| Jamf::PrestageSyncStatus.new ss }
-      end
-    end # self.sync_status(prestage = nil, latest = false, cnx: Jamf.cnx)
-
-    # Instance Methods
-    ###############################################
-
-    def sync_status(latest = false)
-      self.class.sync_status @id, latest, cnx: @cnx
-    end
-
-  end # class
-
-end # module

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

@@ -1,226 +0,0 @@
-# Copyright 2020 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.
-#
-#
-
-# The Module
-module Jamf
-
-  # Classes
-  #####################################
-
-  # A building defined in the JSS
-  class Script < Jamf::CollectionResource
-
-    # Mix-Ins
-    #####################################
-
-    include Jamf::ChangeLog
-    include Jamf::Referable
-
-    # Constants
-    #####################################
-
-    RSRC_VERSION = 'v1'.freeze
-    RSRC_PATH = 'scripts'.freeze
-
-    PRIORITY_BEFORE = 'BEFORE'.freeze
-    PRIORITY_AFTER = 'AFTER'.freeze
-    PRIORITY_AT_REBOOT = 'AT_REBOOT'.freeze
-
-    PRIORTIES = [
-      PRIORITY_BEFORE,
-      PRIORITY_AFTER,
-      PRIORITY_AT_REBOOT
-    ].freeze
-
-    # Object Model / Attributes
-    # See APIObject class documentation for details
-    # of how the OBJECT_MODEL hash works.
-    #####################################
-    OBJECT_MODEL = {
-
-      # @!attribute [r] id
-      #   @return [Integer]
-      id: {
-        class: :j_id,
-        identifier: :primary,
-        readonly: true,
-        filter_key: true
-      },
-
-      # @!attribute name
-      #   @return [String]
-      name: {
-        class: :string,
-        identifier: true,
-        filter_key: true
-      },
-
-      # @!attribute info
-      #   @return [String]
-      info: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute notes
-      #   @return [String]
-      notes: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute priority
-      #   @return [String]
-      priority: {
-        class: :string,
-        enum: Jamf::Script::PRIORTIES,
-        filter_key: true
-      },
-
-      # TODO: Jamf should standardize object references
-      # this should be a Category::Reference object
-
-      # @!attribute categoryId
-      #   @return [Integer]
-      categoryId: {
-        class: :j_id,
-        filter_key: true
-      },
-
-      # @!attribute categoryName
-      #   @return [String]
-      categoryName: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute osRequirements
-      #   @return [String]
-      osRequirements: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute scriptContents
-      #   @return [String]
-      scriptContents: {
-        class: :string,
-        validate: :script_contents,
-        aliases: %i[code],
-        filter_key: true
-      },
-
-      # @!attribute parameter4
-      #   @return [String]
-      parameter4: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute parameter5
-      #   @return [String]
-      parameter5: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute parameter6
-      #   @return [String]
-      parameter6: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute parameter7
-      #   @return [String]
-      parameter7: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute parameter8
-      #   @return [String]
-      parameter8: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute parameter9
-      #   @return [String]
-      parameter9: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute parameter10
-      #   @return [String]
-      parameter10: {
-        class: :string,
-        filter_key: true
-      },
-
-      # @!attribute parameter11
-      #   @return [String]
-      parameter11: {
-        class: :string,
-        filter_key: true
-      }
-    }.freeze
-
-    parse_object_model
-
-    # Class Methods
-    ##################################
-
-    # 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
-
-end # module

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

@@ -1,141 +0,0 @@
-# Copyright 2020 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
-
-  # The API endpoint for country codes.
-  #
-  # Probably more useful is the Jamf.app_store_country_codes method
-  # which parses this into a hash of Code => Name
-  #
-  class AppStoreCountryCodes < Jamf::SingletonResource
-
-    # Mix-Ins
-    #####################################
-
-    extend Jamf::Immutable
-
-    # Constants
-    #####################################
-
-    RSRC_VERSION = 'v1'.freeze
-
-    RSRC_PATH = 'app-store-country-codes'.freeze
-
-    OBJECT_MODEL = {
-
-      # @!attribute checkInFrequency
-      #   @return [integer]
-      countryCodes: {
-        class: Jamf::Country,
-        multi: true,
-        read_only: true,
-        aliases: [:list]
-      }
-
-    }.freeze # end OBJECT_MODEL
-
-    parse_object_model
-
-    # 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
-    end
-
-    # Class level wrapper for #codes
-    def self.codes(refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).codes
-    end
-
-    # Class level wrapper for #codes_by_name
-    def self.codes_by_name(refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).codes_by_name
-    end
-
-    # Class level wrapper for #names_by_code
-    def self.names_by_code(refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).names_by_code
-    end
-
-    # Class level wrapper for #code_for_name
-    def self.code_for_name(name, refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).code_for_name name
-    end
-
-    # Class level wrapper for #name_for_code
-    def self.name_for_code(code, refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).name_for_code code
-    end
-
-    # Instance Methods
-    #####################################
-
-    # @return [Array<String>] the available country names
-    def names
-      @names ||= countryCodes.map(&:name)
-    end
-
-    # @return [Array<String>] the available country codes
-    def codes
-      @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
-    end
-
-    # @return [Hash] code => name
-    def names_by_code
-      @names_by_code ||= countryCodes.map { |country| [country.code, country.name] }.to_h
-    end
-
-    # return a country code from its name, case-insensitive
-    # @param name[String] the name of a country
-    # @return [String]
-    def code_for_name(name)
-      name = names.select { |n| n.casecmp? name }.first
-      codes_by_name[name]
-    end
-
-    # return a country name from its code, case-insensitive
-    # @param name[String] the name of a country
-    # @return [String]
-    def name_for_code(code)
-      names_by_code[code.upcase]
-    end
-
-  end # class AppStoreCountryCodes
-
-end # module JAMF

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

@@ -1,155 +0,0 @@
-# Copyright 2020 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.
-#
-#
-
-# The Module
-module Jamf
-
-  # Classes
-  #####################################
-
-  # A list of known timezones
-  class Locales < Jamf::SingletonResource
-
-    # Mix-Ins
-    #####################################
-
-    extend Jamf::Immutable
-
-    # Constants
-    #####################################
-
-    RSRC_VERSION = 'v1'.freeze
-
-    RSRC_PATH = 'locales'.freeze
-
-    OBJECT_MODEL = {
-
-      # @!attribute checkInFrequency
-      #   @return [integer]
-      locales: {
-        class: Jamf::Locale,
-        multi: true,
-        read_only: true,
-        aliases: [:list]
-      }
-
-    }.freeze # end OBJECT_MODEL
-
-    parse_object_model
-
-    # TEMP? until this endpoint is brought up to standards
-    # the data from the API is a raw Array, but it should be a
-    # Hash containing an array.
-    def initialize(data, cnx: Jamf.cnx)
-      data = { locales: data }
-      super data, cnx: cnx
-    end
-
-    # Class Methods
-    #####################################
-
-    # @return [Array<Jamf::Locale>] all the locales available
-    #
-    def self.list(refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).locales
-    end
-
-    # Class level wrapper for #descriptions
-    def self.descriptions(refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).descriptions
-    end
-    # how to alias a class method
-    singleton_class.send(:alias_method, :names, :descriptions)
-
-    # Class level wrapper for #identifiers
-    def self.identifiers(refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).identifiers
-    end
-    singleton_class.send(:alias_method, :ids, :identifiers)
-
-    # Class level wrapper for #ids_by_desc
-    def self.ids_by_desc(refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).ids_by_desc
-    end
-
-    # Class level wrapper for #descs_by_id
-    def self.descs_by_id(refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).descs_by_id
-    end
-
-    # Class level wrapper for #id_for_desc
-    def self.id_for_desc(desc, refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).id_for_desc desc
-    end
-
-    # Class level wrapper for #desc_for_id
-    def self.desc_for_id(id, refresh = false, cnx: Jamf.cnx)
-      fetch(refresh, cnx: cnx).desc_for_id id
-    end
-
-    # Instance Methods
-    #####################################
-
-    # @return [Array<String>] the available descriptions
-    def descriptions
-      @descriptions ||= locales.map(&:description)
-    end
-    alias names descriptions
-
-    # @return [Array<String>] the available identifiers
-    def identifiers
-      @identifiers ||= locales.map(&:identifier)
-    end
-    alias ids identifiers
-
-    # @return [Hash] name => code
-    def ids_by_desc
-      @ids_by_desc ||= locales.map { |l| [l.description, l.identifier] }.to_h
-    end
-
-    # @return [Hash] code => name
-    def descs_by_id
-      @descs_by_id ||= locales.map { |l| [l.identifier, l.description] }.to_h
-    end
-
-    # return an identifier from its description, case-insensitive
-    # @param desc[String] the description of a locale
-    # @return [String]
-    def id_for_desc(desc)
-      desc = descriptions.select { |n| n.casecmp? desc }.first
-      ids_by_desc[desc]
-    end
-
-    # return a description from its identifier, case-insensitive
-    # @param name[String] the identifier of a local
-    # @return [String]
-    def desc_for_id(id)
-      id = identifiers.select { |n| n.casecmp? id }.first
-      descs_by_id[id]
-    end
-
-  end # class
-
-end # module