ruby-jss 1.4.1 → 1.6.0

data/lib/jamf/api/abstract_classes/generic_reference.rb

@@ -1,145 +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
-
-  # This class is a reference to an individual API object from some other
-  # API object.
-  #
-  # This class is subclassed automatically when the {Jamf::Referable} module
-  # is included into a class.
-  #
-  # See {Jamf::Referable} for how to use the subclasses of GenericReference.
-  #
-  # Subclasses must define:
-  #
-  # REFERENT_CLASS - the full class to which this is a reference
-  # e.g. for BuildingReference it would be Jamf::Building
-  #
-  # Defining REFERENT_CLASS is handled automatically by including the
-  # Referable module
-  #
-  # @abstract
-  #
-  class GenericReference < Jamf::JSONObject
-
-    extend Jamf::Abstract
-
-    # Constants
-    #####################################
-
-    OBJECT_MODEL = {
-
-      id: {
-        class: :integer,
-        identifier: :primary,
-        readonly: true
-      },
-
-      name: {
-        class: :string,
-        readonly: true
-      }
-
-    }.freeze
-    parse_object_model
-
-    # Constructor
-    #####################################
-
-    # Make a new reference to an API CollectionResource Object
-    #
-    # The data parameter can be one of:
-    #
-    # 1) A Hash with an :id and :name
-    #    This is mostly used automatically when parsing fetched API data.
-    #    When some attribute of an OBJECT_MODEL has `class: Someclass::Reference`
-    #    the JSON hash from the API will be passed as the data param.
-    #
-    #    e.g.
-    #    - Policy::OBJECT_MODEL[:category][:class] is Jamf::Category::Reference
-    #    - the policy JSON from the api might contain `category: { id: 234, name: 'foobar' }`
-    #    - that hash will be passed into Jamf::Category::Reference.new, and the
-    #      resulting instance used as the value of the  policy's :category attribute.
-    #
-    # 2) An instance of the REFERENT_CLASS.
-    #   This can be used to make a reference to some specific instance of
-    #   the referent class.
-    #
-    #   e.g. if you have an instance of Category in the variable `my_cat`
-    #   then `ref_to_my_cat = Category::Reference.new my_cat` will work as
-    #   expected.
-    #
-    # 3) A valid identifier for an existing REFERENT_CLASS in the JSS.
-    #    The given value will be used with the REFERENT_CLASS's .valid_id method
-    #    to see if there's a matching instance, which the reference refers to.
-    #
-    #    e.g. `ref_to_my_cat = Category::Reference.new 12` creates a reference
-    #    to Category id 12, and `ref_to_my_cat = Category::Reference.new 'foo'`
-    #    creates a reference to the category named 'foo' - assuming they exist.
-    #
-    # The last two of these are commonly used with setters for attributes that
-    # have class: <some reference class>
-    #
-    # e.g. setting the category of a policy when
-    # Policy::OBJECT_MODEL[:category] is Category::Reference
-    #
-    #   `mypolicy.category = a_cat` # a_cat is a Category instance
-    #   `mypolicy.category = 12`    # use categoty id 12
-    #   `mypolicy.category = 'foo'` # use categoty named 'foo'
-    #
-    #
-    #
-    # @param data[Hash,CollectionResource,String,Integer]
-    #
-    def initialize(data, cnx: Jamf.cnx)
-      ref_class = self.class::REFERENT_CLASS
-      case data
-      when Hash
-        super
-      when ref_class
-        raise Jamf::InvalidDataError, "Provided #{ref_class} hasn't been created" unless data.exist?
-        @id = data.id
-        @name = data.name if data.respond_to? :name
-        @cnx = data.cnx
-      when nil
-        @id = nil
-        @name = nil
-        @cnx = cnx
-      else
-        @id = ref_class.valid_id data, cnx: cnx
-        raise "No matching #{ref_class}" unless @id
-        @name = ref_class.map_all(:id, to: :name, cnx: cnx)[@id]
-      end
-    end
-
-    def to_jamf
-      return nil if @id.nil?
-      { id: @id }
-    end
-
-  end # class
-
-end # module

data/lib/jamf/api/abstract_classes/prestage_skip_setup_items.rb

@@ -1,126 +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
-
-  # A class that represents the 'Skip' settings for
-  # various Setup options in a DEP prestage
-  # The object model here includes the attributes common
-  # to both Computer and MobileDevice prestages
-  class PrestageSkipSetupItems < Jamf::JSONObject
-
-    extend Jamf::Abstract
-
-    OBJECT_MODEL = {
-
-      # @!attribute Appearance
-      #   @return [Boolean]
-      Appearance: {
-        class: :boolean,
-        aliases: %i[appearance]
-      },
-
-      # @!attribute AppleID
-      #   @return [Boolean]
-      AppleID: {
-        class: :boolean,
-        aliases: %i[appleID appleid apple_id]
-      },
-
-      # @!attribute Biometric
-      #   @return [Boolean]
-      Biometric: {
-        class: :boolean,
-        aliases: %i[biometric]
-      },
-
-      # @!attribute Diagnostics
-      #   @return [Boolean]
-      Diagnostics: {
-        class: :boolean,
-        aliases: %i[diagnostics]
-      },
-
-      # @!attribute DisplayTone
-      #   @return [Boolean]
-      DisplayTone: {
-        class: :boolean,
-        aliases: %i[displaytone display_tone]
-      },
-
-      # @!attribute Location
-      #   @return [Boolean]
-      Location: {
-        class: :boolean,
-        aliases: %i[location]
-      },
-
-      # @!attribute Payment
-      #   @return [Boolean]
-      Payment: {
-        class: :boolean,
-        aliases: %i[payment]
-      },
-
-      # @!attribute Privacy
-      #   @return [Boolean]
-      Privacy: {
-        class: :boolean,
-        aliases: %i[privacy]
-      },
-
-      # @!attribute Restore
-      #   @return [Boolean]
-      Restore: {
-        class: :boolean,
-        aliases: %i[restore]
-      },
-
-      # @!attribute ScreenTime
-      #   @return [Boolean]
-      ScreenTime: {
-        class: :boolean,
-        aliases: %i[screenTime screentime]
-      },
-
-      # @!attribute Siri
-      #   @return [Boolean]
-      Siri: {
-        class: :boolean,
-        aliases: %i[siri]
-      },
-
-      # @!attribute TOS
-      #   @return [Boolean]
-      TOS: {
-        class: :boolean,
-        aliases: %i[tos terms_of_service]
-      }
-    }.freeze
-
-  end # class location
-
-end # module

data/lib/jamf/api/json_objects/account_prefs.rb

@@ -1,79 +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
-  #####################################
-
-  # Preferences for an administrator account in the JSS
-  class AccountPreferences < Jamf::JSONObject
-
-    # Object Model / Attributes
-    # See APIObject class documentation for details
-    # of how the OBJECT_MODEL hash works.
-    #####################################
-    OBJECT_MODEL = {
-
-      # @!attribute [r] language
-      #   @return [String]
-      language: {
-        class: :string,
-        readonly: true
-      },
-
-      # @!attribute [r] dateFormat
-      #   @return [String]
-      dateFormat: {
-        class: :string,
-        readonly: true
-      },
-
-      # @!attribute [r] region
-      #   @return [String]
-      region: {
-        class: :string,
-        readonly: true
-      },
-      # @!attribute [r] timezone
-      #   @return [String]
-      timezone: {
-        class: :string,
-        readonly: true
-      },
-
-      # @!attribute [r] isDisableRelativeDates
-      #   @return [String]
-      isDisableRelativeDates: {
-        class: :boolean,
-        readonly: true
-      }
-    }.freeze
-    parse_object_model
-
-  end # class
-
-end # module

data/lib/jamf/api/json_objects/android_details.rb

@@ -1,139 +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
-
-  class AndroidDetails < Jamf::JSONObject
-
-    # Class Constants
-    #####################################
-
-    OBJECT_MODEL = {
-
-      # @!attribute [r] osName
-      #   @return [String]
-      osName: {
-        class: :string,
-        readonly: true
-      },
-
-      # @!attribute [r] manufacturer
-      #   @return [String]
-      manufacturer: {
-        class: :string,
-        readonly: true
-      },
-
-      # @!attribute [r] model
-      #   @return [String]
-      model: {
-        class: :string,
-        readonly: true
-      },
-
-      # @!attribute [r] internalCapacityMb
-      #   @return [Integer]
-      internalCapacityMb: {
-        class: :integer,
-        readonly: true
-      },
-
-      # @!attribute [r] internalAvailableMb
-      #   @return [Integer]
-      internalAvailableMb: {
-        class: :integer,
-        readonly: true
-      },
-
-      # @!attribute [r] internalPercentUsed
-      #   @return [Integer]
-      internalPercentUsed: {
-        class: :integer,
-        readonly: true
-      },
-
-      # @!attribute [r] externalCapacityMb
-      #   @return [Integer]
-      externalCapacityMb: {
-        class: :integer,
-        readonly: true
-      },
-
-      # @!attribute [r] externalAvailableMb
-      #   @return [Integer]
-      externalAvailableMb: {
-        class: :integer,
-        readonly: true
-      },
-
-      # @!attribute [r] externalPercentUsed
-      #   @return [Integer]
-      externalPercentUsed: {
-        class: :integer,
-        readonly: true
-      },
-
-      # @!attribute [r] batteryLevel
-      #   @return [Integer]
-      batteryLevel: {
-        class: :integer,
-        readonly: true
-      },
-
-      # @!attribute [r] lastBackupTimestamp
-      #   @return [Jamf::Timestamp]
-      lastBackupTimestamp: {
-        class: Jamf::Timestamp,
-        readonly: true,
-        aliases: %i[lastBackup]
-      },
-
-      # @!attribute [r] apiVersion
-      #   @return [Integer]
-      apiVersion: {
-        class: :integer,
-        readonly: true
-      },
-
-      # @!attribute [r] computer
-      #   @return [Jamf::Computer::Reference]
-      computer: {
-        class: Jamf::Computer::Reference,
-        readonly: true
-      },
-
-      # @!attribute [r] security
-      #   @return [Jamf::MobileDevic:Security]
-      security: {
-        class: Jamf::MobileDeviceSecurity,
-        readonly: true
-      }
-    }.freeze
-    parse_object_model
-
-  end # class Details
-
-end # module