ruby-jss 4.2.0b2 → 4.2.0

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

@@ -0,0 +1,96 @@
+# 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: PlanGroupPost
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # 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.
+    #
+    # 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::ManagedSoftwareUpdatePlanGroupPost
+    #
+    # 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 PlanGroupPost < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      OBJECT_TYPE_OPTIONS = [
+        'COMPUTER_GROUP',
+        'MOBILE_DEVICE_GROUP'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute groupId
+        #   @return [String]
+        groupId: {
+          class: :string,
+          required: true,
+          min_length: 1
+        },
+
+        # @!attribute objectType
+        #   @return [String]
+        objectType: {
+          class: :string,
+          required: true,
+          enum: OBJECT_TYPE_OPTIONS
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class PlanGroupPost
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,89 @@
+# 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: PlanSearchResults
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # 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.
+    #
+    # 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.
+    #  
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  - Jamf::OAPISchemas::JamfProtectPlan
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/jamf-protect/plans:GET' needs permissions:
+    #    - Read Jamf Protect Deployments
+    #
+    #
+    class PlanSearchResults < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer
+        },
+
+        # @!attribute results
+        #   @return [Array<Jamf::OAPISchemas::JamfProtectPlan>]
+        results: {
+          class: Jamf::OAPISchemas::JamfProtectPlan,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class PlanSearchResults
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,127 @@
+# 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: PlanStatus
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # 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.
+    #
+    # 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::ManagedSoftwareUpdatePlan
+    #
+    # 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 PlanStatus < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      STATE_OPTIONS = [
+        'Init',
+        'PendingPlanValidation',
+        'AcceptingPlan',
+        'RejectingPlan',
+        'ProcessingPlanType',
+        'ProcessingPlanTypeMdm',
+        'StartingPlan',
+        'PlanFailed',
+        'SchedulingScanForOSUpdates',
+        'ProcessingScheduleOSUpdateScanResponse',
+        'WaitingForScheduledOSUpdateScanToComplete',
+        'CollectingAvailableOSUpdates',
+        'ProcessingAvailableOSUpdatesResponse',
+        'ProcessingSchedulingType',
+        'SchedulingDDM',
+        'DDMPlanScheduled',
+        'WaitingToStartDDMUpdate',
+        'ProcessingDDMStatusResponse',
+        'CollectingDDMStatus',
+        'SchedulingMDM',
+        'MDMPlanScheduled',
+        'SchedulingOSUpdate',
+        'ProcessingScheduleOSUpdateResponse',
+        'CollectingOSUpdateStatus',
+        'ProcessingOSUpdateStatusResponse',
+        'WaitingToCollectOSUpdateStatus',
+        'VerifyingInstallation',
+        'ProcessingInstallationVerification',
+        'PlanCompleted',
+        'PlanCanceled',
+        'PlanException',
+        'Unknown'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] state
+        #   @return [String]
+        state: {
+          class: :string,
+          readonly: true,
+          enum: STATE_OPTIONS
+        },
+
+        # @!attribute [r] errorReasons
+        #   @return [Array<String>]
+        errorReasons: {
+          class: :string,
+          nil_ok: true,
+          readonly: true,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class PlanStatus
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/{device_enrollment_prestage.rb → prestage_purchasing_information.rb}

@@ -21,6 +21,7 @@
 #    language governing permissions and limitations under the Apache License.
 #
 
+
 module Jamf
 
   # This module is the namespace for all objects defined
@@ -28,7 +29,8 @@ module Jamf
   #
   module OAPISchemas
 
-    # OAPI Object Model and Enums for: DeviceEnrollmentPrestage
+
+    # OAPI Object Model and Enums for: PrestagePurchasingInformation
     #
     #
     #
@@ -46,12 +48,11 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #
+    #  - Jamf::OAPISchemas::DeviceEnrollmentPrestage
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #  - Jamf::OAPISchemas::LocationInformation
-    #  - Jamf::OAPISchemas::PrestagePurchasingInformation
+    #  
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
@@ -59,152 +60,114 @@ module Jamf
     #
     #
     #
-    class DeviceEnrollmentPrestage < Jamf::OAPIObject
+    class PrestagePurchasingInformation < Jamf::OAPIObject
+
+      
 
       OAPI_PROPERTIES = {
 
-        # @!attribute displayName
-        #   @return [String]
-        displayName: {
-          class: :string,
-          required: true
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          required: true,
+          identifier: :primary
         },
 
-        # @!attribute isMandatory
+        # @!attribute isLeased
         #   @return [Boolean]
-        isMandatory: {
+        isLeased: {
           class: :boolean,
           required: true
         },
 
-        # @!attribute isMdmRemovable
+        # @!attribute isPurchased
         #   @return [Boolean]
-        isMdmRemovable: {
+        isPurchased: {
           class: :boolean,
           required: true
         },
 
-        # @!attribute supportPhoneNumber
+        # @!attribute appleCareID
         #   @return [String]
-        supportPhoneNumber: {
+        appleCareID: {
           class: :string,
           required: true
         },
 
-        # @!attribute supportEmailAddress
+        # @!attribute poNumber
         #   @return [String]
-        supportEmailAddress: {
+        poNumber: {
           class: :string,
           required: true
         },
 
-        # @!attribute department
+        # @!attribute vendor
         #   @return [String]
-        department: {
+        vendor: {
           class: :string,
           required: true
         },
 
-        # @!attribute isDefaultPrestage
-        #   @return [Boolean]
-        isDefaultPrestage: {
-          class: :boolean,
+        # @!attribute purchasePrice
+        #   @return [String]
+        purchasePrice: {
+          class: :string,
           required: true
         },
 
-        # @!attribute enrollmentSiteId
+        # @!attribute lifeExpectancy
         #   @return [Integer]
-        enrollmentSiteId: {
+        lifeExpectancy: {
           class: :integer,
           required: true
         },
 
-        # @!attribute isKeepExistingSiteMembership
-        #   @return [Boolean]
-        isKeepExistingSiteMembership: {
-          class: :boolean,
-          required: true
-        },
-
-        # @!attribute isKeepExistingLocationInformation
-        #   @return [Boolean]
-        isKeepExistingLocationInformation: {
-          class: :boolean,
+        # @!attribute purchasingAccount
+        #   @return [String]
+        purchasingAccount: {
+          class: :string,
           required: true
         },
 
-        # @!attribute isRequireAuthentication
-        #   @return [Boolean]
-        isRequireAuthentication: {
-          class: :boolean,
+        # @!attribute purchasingContact
+        #   @return [String]
+        purchasingContact: {
+          class: :string,
           required: true
         },
 
-        # @!attribute authenticationPrompt
+        # @!attribute leaseDate
         #   @return [String]
-        authenticationPrompt: {
+        leaseDate: {
           class: :string,
           required: true
         },
 
-        # @!attribute isPreventActivationLock
-        #   @return [Boolean]
-        isPreventActivationLock: {
-          class: :boolean,
+        # @!attribute poDate
+        #   @return [String]
+        poDate: {
+          class: :string,
           required: true
         },
 
-        # @!attribute isEnableDeviceBasedActivationLock
-        #   @return [Boolean]
-        isEnableDeviceBasedActivationLock: {
-          class: :boolean,
+        # @!attribute warrantyDate
+        #   @return [String]
+        warrantyDate: {
+          class: :string,
           required: true
         },
 
-        # @!attribute deviceEnrollmentProgramInstanceId
+        # @!attribute versionLock
         #   @return [Integer]
-        deviceEnrollmentProgramInstanceId: {
+        versionLock: {
           class: :integer,
           required: true
-        },
-
-        # @!attribute skipSetupItems
-        #   @return [Hash{Symbol: Boolean }]
-        skipSetupItems: {
-          class: :hash
-        },
-
-        # @!attribute locationInformation
-        #   @return [Jamf::OAPISchemas::LocationInformation]
-        locationInformation: {
-          class: Jamf::OAPISchemas::LocationInformation,
-          required: true
-        },
-
-        # @!attribute purchasingInformation
-        #   @return [Jamf::OAPISchemas::PrestagePurchasingInformation]
-        purchasingInformation: {
-          class: Jamf::OAPISchemas::PrestagePurchasingInformation,
-          required: true
-        },
-
-        # The Base64 encoded PEM Certificate
-        # @!attribute anchorCertificates
-        #   @return [Array<String>]
-        anchorCertificates: {
-          class: :string,
-          multi: true
-        },
-
-        # @!attribute enrollmentCustomizationId
-        #   @return [Integer]
-        enrollmentCustomizationId: {
-          class: :integer
         }
 
       } # end OAPI_PROPERTIES
 
-    end # class DeviceEnrollmentPrestage
+    end # class PrestagePurchasingInformation
 
   end # module OAPISchemas