ruby-jss 4.2.0b2 → 4.2.1

data/lib/jamf/api/jamf_pro/oapi_schemas/prestage_purchasing_information_v2.rb

@@ -0,0 +1,174 @@
+# Copyright 2025 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 module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: PrestagePurchasingInformationV2
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::DeviceEnrollmentPrestageV2
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class PrestagePurchasingInformationV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          required: true,
+          identifier: :primary
+        },
+
+        # @!attribute leased
+        #   @return [Boolean]
+        leased: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute purchased
+        #   @return [Boolean]
+        purchased: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute appleCareId
+        #   @return [String]
+        appleCareId: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute poNumber
+        #   @return [String]
+        poNumber: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute vendor
+        #   @return [String]
+        vendor: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute purchasePrice
+        #   @return [String]
+        purchasePrice: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute lifeExpectancy
+        #   @return [Integer]
+        lifeExpectancy: {
+          class: :integer,
+          required: true
+        },
+
+        # @!attribute purchasingAccount
+        #   @return [String]
+        purchasingAccount: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute purchasingContact
+        #   @return [String]
+        purchasingContact: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute leaseDate
+        #   @return [String]
+        leaseDate: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute poDate
+        #   @return [String]
+        poDate: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute warrantyDate
+        #   @return [String]
+        warrantyDate: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute versionLock
+        #   @return [Integer]
+        versionLock: {
+          class: :integer,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class PrestagePurchasingInformationV2
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/prestage_scope_assignment_v2.rb

@@ -0,0 +1,94 @@
+# Copyright 2025 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 module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: PrestageScopeAssignmentV2
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::PrestageScopeResponseV2
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class PrestageScopeAssignmentV2 < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute serialNumber
+        #   @return [String]
+        serialNumber: {
+          class: :string
+        },
+
+        # @!attribute assignmentDate
+        #   @return [Jamf::Timestamp]
+        assignmentDate: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute userAssigned
+        #   @return [String]
+        userAssigned: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class PrestageScopeAssignmentV2
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/v1_site.rb

@@ -0,0 +1,91 @@
+# Copyright 2025 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 module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: V1Site
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    #
+    # This class may be used directly, e.g instances of other classes may
+    # use instances of this class as one of their own properties/attributes.
+    #
+    # It may also be used as a superclass when implementing Jamf Pro API
+    # Resources in ruby-jss. The subclasses include appropriate mixins, and
+    # should expand on the basic functionality provided here.
+    #
+    #
+    # Container Objects:
+    # Other object models that use this model as the value in one
+    # of their attributes.
+    #  - Jamf::OAPISchemas::AuthorizationV1
+    #  - Jamf::OAPISchemas::ComputerGeneral
+    #  - Jamf::OAPISchemas::MobileDeviceDetailsV2
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/sites:GET' needs permissions:
+    #    - Read Sites
+    #
+    #
+    class V1Site < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class V1Site
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas.rb

@@ -25,8 +25,31 @@
 # The module
 module Jamf
 
-  # This module is the namespace for all objects defined
+  # This module is the namespace for all JP API objects defined
   # in the OAPI JSON schema under the components => schemas key
+  #
+  # The classes in this module are the Ruby representations of the
+  # JSON schema objects (Hashes) in the Jamf Pro OAPI schema
+  #
+  # Each class is created from the JSON Object definition and other
+  # schema data, such as required attributes, the class or type of each
+  # attribute (which could be another OAPI object), and any enumurated
+  # values for attributes.
+  # The classes are all subclasses of Jamf::OAPIObject, which defines
+  # common methods for all OAPI objects, such as converting to and from
+  # JSON, and validating attribute values.
+  #
+  # These clases are used in various ways in ruby-jss:
+  # - As the value of an attribute in another OAPI object
+  # - As the parent class for a Jamf Pro API Resource class
+  # - As a representation of a JSON objects sent to or received from the API
+  #   (e.g. in a POST or PUT request)
+  #
+  # They are mostly generated automatically using the 'generate_object_models'
+  # executable in the 'bin' directory of ruby-jss. After generation the files needed
+  # are manually edited to add any needed functionality or clarifications of names
+  # etc, and then they are moved into the 'jamf/api/jamf_pro/oapi_schemas' directory.
+  #
   #####################################
   module OAPISchemas
 

data/lib/jamf/api/jamf_pro/other_classes/pager.rb

@@ -226,7 +226,13 @@ module Jamf
 
       data = @cnx.jp_get "#{@query_path}&page=#{page_number}"
       data = data[:results]
-      data.map! { |r| @instantiate.new r } if @instantiate
+
+      if @instantiate
+        data.map! do |r|
+          r[:cnx] = @cnx
+          @instantiate.new(**r)
+        end
+      end
 
       if increment_next
         @last_fetched_page = page_number