RubyGems - ruby-jss - Versions diffs - 4.1.1 → 4.2.0 - Mend

ruby-jss 4.1.1 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (779) hide show

data/lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_prestage_v2.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: MobileDevicePrestageV2
     #
     #
@@ -48,7 +46,7 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
@@ -63,8 +61,6 @@ module Jamf
     #
     class MobileDevicePrestageV2 < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute allowPairing
@@ -165,7 +161,6 @@ module Jamf
         userSessionTimeout: {
           class: :integer
         }
       }.merge(Jamf::OAPISchemas::DeviceEnrollmentPrestageV2::OAPI_PROPERTIES) # end OAPI_PROPERTIES
     end # class MobileDevicePrestageV2

data/lib/jamf/api/jamf_pro/oapi_schemas/o_auth_client_credentials.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: OAuthClientCredentials
     #
     #
@@ -48,11 +46,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -63,8 +61,6 @@ module Jamf
     #
     class OAuthClientCredentials < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute clientId

data/lib/jamf/api/jamf_pro/oapi_schemas/object_history_note.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: ObjectHistoryNote
     #
     #
@@ -48,11 +46,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -129,8 +127,6 @@ module Jamf
     #
     class ObjectHistoryNote < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute note

data/lib/jamf/api/jamf_pro/oapi_schemas/object_history_v1.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: ObjectHistoryV1
     #
     #
@@ -52,7 +50,7 @@ module Jamf
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -62,8 +60,6 @@ module Jamf
     #
     class ObjectHistoryV1 < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute id

data/lib/jamf/api/jamf_pro/oapi_schemas/package.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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

data/lib/jamf/api/jamf_pro/oapi_schemas/packages_search_results.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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

data/lib/jamf/api/jamf_pro/oapi_schemas/plan_configuration_post.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically generated from the api/schema
-    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    # URL path on a Jamf Pro server version 11.14.1-t1740408745756
     #
     # 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.
@@ -79,6 +79,7 @@ module Jamf
         'LATEST_MINOR',
         'LATEST_ANY',
         'SPECIFIC_VERSION',
+        'CUSTOM_VERSION',
         'UNKNOWN'
       ]
@@ -100,7 +101,7 @@ module Jamf
           enum: VERSION_TYPE_OPTIONS
         },
-        # Optional. Indicates the specific version to update to. Only available when the version type is set to specific version, otherwise defaults to NO_SPECIFIC_VERSION.
+        # Optional. Indicates the specific version to update to. Only available when the version type is set to specific version or custom version, otherwise defaults to NO_SPECIFIC_VERSION.
         # @!attribute specificVersion
         #   @return [String]
         specificVersion: {
@@ -108,6 +109,14 @@ module Jamf
           min_length: 0
         },
+        # Optional. Indicates the build version to update to. Only available when the version type is set to custom version.
+        # @!attribute buildVersion
+        #   @return [String]
+        buildVersion: {
+          class: :string,
+          nil_ok: true
+        },
         # Required when the provided updateAction is DOWNLOAD_INSTALL_ALLOW_DEFERRAL, not applicable to all managed software update plans
         # @!attribute maxDeferrals
         #   @return [Integer]

data/lib/jamf/api/jamf_pro/oapi_schemas/plan_device.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically generated from the api/schema
-    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    # URL path on a Jamf Pro server version 11.14.1-t1740408745756
     #
     # 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.

data/lib/jamf/api/jamf_pro/oapi_schemas/plan_device_post.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically generated from the api/schema
-    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    # URL path on a Jamf Pro server version 11.14.1-t1740408745756
     #
     # 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.

data/lib/jamf/api/jamf_pro/oapi_schemas/plan_device_response.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically generated from the api/schema
-    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    # URL path on a Jamf Pro server version 11.14.1-t1740408745756
     #
     # 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.

data/lib/jamf/api/jamf_pro/oapi_schemas/plan_group_post.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically generated from the api/schema
-    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    # URL path on a Jamf Pro server version 11.14.1-t1740408745756
     #
     # 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.

data/lib/jamf/api/jamf_pro/oapi_schemas/plan_search_results.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically generated from the api/schema
-    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    # URL path on a Jamf Pro server version 11.14.1-t1740408745756
     #
     # 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.

data/lib/jamf/api/jamf_pro/oapi_schemas/plan_status.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically generated from the api/schema
-    # URL path on a Jamf Pro server version 11.6.1-t1718634702
+    # URL path on a Jamf Pro server version 11.14.1-t1740408745756
     #
     # 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.
@@ -70,6 +70,7 @@ module Jamf
         'AcceptingPlan',
         'RejectingPlan',
         'ProcessingPlanType',
+        'ProcessingPlanTypeMdm',
         'StartingPlan',
         'PlanFailed',
         'SchedulingScanForOSUpdates',

data/lib/jamf/api/jamf_pro/oapi_schemas/post_computer_prestage_v3.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: PostComputerPrestageV3
     #
     #
@@ -48,7 +46,7 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
@@ -63,8 +61,6 @@ module Jamf
     #
     class PostComputerPrestageV3 < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute accountSettings
@@ -81,7 +77,6 @@ module Jamf
           writeonly: true,
           min_length: 1
         }
       }.merge(Jamf::OAPISchemas::ComputerPrestageV3::OAPI_PROPERTIES) # end OAPI_PROPERTIES
     end # class PostComputerPrestageV3

data/lib/jamf/api/jamf_pro/oapi_schemas/prestage_purchasing_information.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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

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

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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

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

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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

data/lib/jamf/api/jamf_pro/oapi_schemas/prestage_scope_response_v2.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: PrestageScopeResponseV2
     #
     #
@@ -48,7 +46,7 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
@@ -77,8 +75,6 @@ module Jamf
     #
     class PrestageScopeResponseV2 < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute prestageId

data/lib/jamf/api/jamf_pro/oapi_schemas/prestage_scope_v2.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: PrestageScopeV2
     #
     #
@@ -48,11 +46,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -65,8 +63,6 @@ module Jamf
     #
     class PrestageScopeV2 < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute serialsByPrestageId

data/lib/jamf/api/jamf_pro/oapi_schemas/put_computer_prestage_v3.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: PutComputerPrestageV3
     #
     #
@@ -48,7 +46,7 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
@@ -63,8 +61,6 @@ module Jamf
     #
     class PutComputerPrestageV3 < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute accountSettings
@@ -88,7 +84,6 @@ module Jamf
           class: :integer,
           minimum: 0
         }
       }.merge(Jamf::OAPISchemas::ComputerPrestageV3::OAPI_PROPERTIES) # end OAPI_PROPERTIES
     end # class PutComputerPrestageV3

data/lib/jamf/api/jamf_pro/oapi_schemas/put_mobile_device_prestage_v2.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: PutMobileDevicePrestageV2
     #
     #
@@ -48,7 +46,7 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
@@ -63,8 +61,6 @@ module Jamf
     #
     class PutMobileDevicePrestageV2 < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute versionLock
@@ -72,7 +68,6 @@ module Jamf
         versionLock: {
           class: :integer
         }
       }.merge(Jamf::OAPISchemas::MobileDevicePrestageV2::OAPI_PROPERTIES) # end OAPI_PROPERTIES
     end # class PutMobileDevicePrestageV2

data/lib/jamf/api/jamf_pro/oapi_schemas/redeploy_jamf_management_framework_response.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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
@@ -21,7 +21,6 @@
 #    language governing permissions and limitations under the Apache License.
 #
 module Jamf
   # This module is the namespace for all objects defined
@@ -29,7 +28,6 @@ module Jamf
   #
   module OAPISchemas
     # OAPI Object Model and Enums for: RedeployJamfManagementFrameworkResponse
     #
     #
@@ -48,11 +46,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #
+    #
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -64,8 +62,6 @@ module Jamf
     #
     class RedeployJamfManagementFrameworkResponse < Jamf::OAPIObject
       OAPI_PROPERTIES = {
         # @!attribute deviceId

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

@@ -1,4 +1,4 @@
-# Copyright 2024 Pixar
+# 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

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# 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
@@ -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/change_log_entry.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")