ruby-jss 1.6.4 → 2.0.0a10

data/lib/jamf/api/jamf_pro/api_objects/jp_building.rb

@@ -0,0 +1,116 @@
+# Copyright 2022 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 in the Jamf Pro API
+  #
+  # Alas we can't migrate Jamf::Building to use the JPAPI - it must stay in the
+  # classic API because of how it interacts Scopes in scopable objects over there.
+  #
+  # The parent class is the OAPI object representing a single member of the
+  # collection, i.e. the 'GET_OBJECT' similar to the POST_OBJECT defined in the
+  # class below.
+  #
+  class JpBuilding < Jamf::OAPISchemas::Building
+
+    include Jamf::CollectionResource
+    extend Jamf::Filterable
+    include Jamf::ChangeLog
+
+    ########### RELATED OAPI OBJECTS
+    # These objects should be OAPIObjects, NOT subclasses of them and
+    # not Collection or Singleton resources.
+    #
+    # TODO: See if these constants can be auto-generated from the
+    # OAPI schema and baked into the parent class
+
+    # The OAPI object class we get back from a 'list' query to get the
+    # whole collection, or a subset of it. It contains a :results key
+    # which is an array of data for objects of the parent class.
+    SEARCH_RESULT_OBJECT = Jamf::OAPISchemas::BuildingSearchResults
+
+    # The OAPI object class we send with a POST request to make a new member of
+    # the collection in Jamf. This is usually the same as the parent class.
+    POST_OBJECT = Jamf::OAPISchemas::Building
+
+    # The OAPI object class we send with a PUT request to change an object in
+    # Jamf by specifying all its values. Most updates happen this way,
+    # and this is usually the same as the parent class
+    PUT_OBJECT = Jamf::OAPISchemas::Building
+
+    # The OAPI object we send with a PATCH request to change an object in
+    # Jamf by replacing only some of its values. This is never the same as the
+    # parent class, and is usually used when many or most of the data about an
+    # object cannot be changed via the API.
+    # PATCH_OBJECT = Jamf::OAPISchemas::Building
+
+    ############# API PATHS
+    # TODO: See if these paths can be auto-generated from the
+    # OAPI schema and baked into the parent class
+
+    # The path for GETting the list of all objects in the collection, possibly
+    # filtered, sorted, and/or paged
+    # REQUIRED for all collection resources
+    #
+    # GET_PATH, POST_PATH, PUT_PATH, PATCH_PATH, and DELETE_PATH are automatically
+    # assumed from the LIST_PATH if they follow the standards:
+    # - GET_PATH = "#{LIST_PATH}/id"
+    #   - fetch an object from the collection
+    # - POST_PATH = LIST_PATH
+    #   - create a new object in the collection
+    # - PUT_PATH = "#{LIST_PATH}/id"
+    #   - update an object passing all its values back.
+    #     Most objects use this or PATCH but not both
+    # - PATCH_PATH = "#{LIST_PATH}/id"
+    #   - update an object passing some of its values back
+    #     Most objects use this or PUT but not both
+    # - DELETE_PATH = "#{LIST_PATH}/id"
+    #   - delete an object from the collection
+    #
+    # If those paths differ from the standards, the constants must be defined
+    # here
+    #
+    LIST_PATH = 'v1/buildings'.freeze
+
+    # See Jamf::CollectionResource::ClassMethods#get_path
+    GET_PATH = LIST_PATH
+
+    # Identifiers not marked in the superclass's OAPI_PROPERTIES constant
+    # which usually only identifies ':id'
+    ALT_IDENTIFIERS = %i[name].freeze
+
+    # Must define this when extending Filterable
+    FILTER_KEYS = %i[
+      name streetAddress1 streetAddress2 city stateProvince zipPostalCode country
+    ].freeze
+
+  end # class
+
+end # module

data/lib/jamf/api/jamf_pro/api_objects/mobile_device_prestage.rb

@@ -0,0 +1,87 @@
+# Copyright 2022 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 in the Jamf Pro API
+  #
+  # The parent class is the OAPI object representing a single member of the
+  # collection, i.e. the 'GET_OBJECT' similar to the POST_OBJECT defined in the
+  # class below.
+  #
+  class MobileDevicePrestage < Jamf::OAPISchemas::GetMobileDevicePrestageV2
+
+    include Jamf::CollectionResource
+    include Jamf::Prestage
+
+    SYNC_PATH = 'syncs'.freeze
+
+    ########### RELATED OAPI OBJECTS
+    # These objects should be OAPIObjects, NOT subclasses of them and
+    # not Collection or Singleton resources.
+    #
+    # TODO: See if these constants can be auto-generated from the
+    # OAPI schema and baked into the parent class
+
+    # The OAPI object class we get back from a 'list' query to get the
+    # whole collection, or a subset of it. It contains a :results key
+    # which is an array of data for objects of the parent class.
+    SEARCH_RESULT_OBJECT = Jamf::OAPISchemas::MobileDevicePrestageSearchResultsV2
+
+    # The OAPI object class we send with a POST request to make a new member of
+    # the collection in Jamf. This is usually the same as the parent class.
+    POST_OBJECT = Jamf::OAPISchemas::MobileDevicePrestageV2
+
+    # The OAPI object class we send with a PUT request to change an object in
+    # Jamf by specifying all its values. Most updates happen this way,
+    # and this is usually the same as the parent class
+    PUT_OBJECT = Jamf::OAPISchemas::PutMobileDevicePrestageV2
+
+    ############# API PATHS
+    # TODO: See if these paths can be auto-generated from the
+    # OAPI schema and baked into the parent class
+
+    # The path for GETting the list of all objects in the collection, possibly
+    # filtered, sorted, and/or paged
+    #
+    # REQUIRED for all collection resources
+    #
+    # GET_, PUT_, PATCH_, POST_, and DELETE_ paths don't need to be
+    # defined if they are the same as LIST_PATH (followed by an id if needed)
+    #
+    LIST_PATH = 'v2/mobile-device-prestages'.freeze
+
+    # alt and non-unique idents are defined in the prestage module
+
+
+    # TODO:  Implement the 'syncs' stuff
+
+  end # class
+
+end # module