ruby-jss 3.2.2 → 4.0.0b1

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

@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.46.0-t1681398190
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
     #
     # 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/patch_summary_version.rb

@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.46.0-t1681398190
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
     #
     # 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/personal_hotspot_setting.rb

@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.46.0-t1681398190
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
     #
     # 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_configuration_post.rb

@@ -0,0 +1,133 @@
+# Copyright 2023 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: PlanConfigurationPost
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    #
+    # 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
+    #  - Jamf::OAPISchemas::ManagedSoftwareUpdatePlanPost
+    #
+    # 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 PlanConfigurationPost < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      UPDATE_ACTION_OPTIONS = [
+        'DOWNLOAD_ONLY',
+        'DOWNLOAD_INSTALL',
+        'DOWNLOAD_INSTALL_ALLOW_DEFERRAL',
+        'DOWNLOAD_INSTALL_RESTART',
+        'DOWNLOAD_INSTALL_SCHEDULE',
+        'UNKNOWN'
+      ]
+
+      VERSION_TYPE_OPTIONS = [
+        'LATEST_MAJOR',
+        'LATEST_MINOR',
+        'LATEST_ANY',
+        'SPECIFIC_VERSION',
+        'UNKNOWN'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute updateAction
+        #   @return [String]
+        updateAction: {
+          class: :string,
+          required: true,
+          enum: UPDATE_ACTION_OPTIONS
+        },
+
+        # @!attribute versionType
+        #   @return [String]
+        versionType: {
+          class: :string,
+          required: true,
+          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.
+        # @!attribute specificVersion
+        #   @return [String]
+        specificVersion: {
+          class: :string,
+          min_length: 0
+        },
+
+        # Required when the provided updateAction is DOWNLOAD_INSTALL_ALLOW_DEFERRAL, not applicable to all managed software update plans
+        # @!attribute maxDeferrals
+        #   @return [Integer]
+        maxDeferrals: {
+          class: :integer,
+          minimum: 0
+        },
+
+        # Optional. Indicates the local date and time of the device to force update by.
+        # @!attribute forceInstallLocalDateTime
+        #   @return [String]
+        forceInstallLocalDateTime: {
+          class: Jamf::Timestamp,
+          nil_ok: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class PlanConfigurationPost
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/{patch_policy_attempt.rb → plan_device.rb}

@@ -30,12 +30,12 @@ module Jamf
   module OAPISchemas
 
 
-    # OAPI Object Model and Enums for: PatchPolicyAttempt
+    # OAPI Object Model and Enums for: PlanDevice
     #
     #
     #
     # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.46.0-t1681398190
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
     #
     # 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.
@@ -48,54 +48,57 @@ module Jamf
     # Container Objects:
     # Other object models that use this model as the value in one
     # of their attributes.
-    #  
+    #  - Jamf::OAPISchemas::ManagedSoftwareUpdatePlan
+    #  - Jamf::OAPISchemas::PlanDeviceResponse
     #
     # Sub Objects:
     # Other object models used by this model's attributes.
-    #  - Jamf::OAPISchemas::PatchPolicyAttemptAction
+    #  
     #
     # Endpoints and Privileges:
     # API endpoints and HTTP operations that use this object
     # model, and the Jamf Pro privileges needed to access them.
-    #  - '/patch/patch-policies/{id}/logs:GET' needs permissions:
-    #    - Read Patch Policies
     #
     #
-    class PatchPolicyAttempt < Jamf::OAPIObject
+    #
+    class PlanDevice < Jamf::OAPIObject
 
-      
+      # Enums used by this class or others
 
-      OAPI_PROPERTIES = {
+      OBJECT_TYPE_OPTIONS = [
+        'COMPUTER',
+        'MOBILE_DEVICE',
+        'APPLE_TV'
+      ]
 
-        # @!attribute id
-        #   @return [Integer]
-        id: {
-          class: :j_id,
-          identifier: :primary
-        },
+      OAPI_PROPERTIES = {
 
-        # @!attribute attemptNo
-        #   @return [Integer]
-        attemptNo: {
-          class: :integer
+        # @!attribute [r] deviceId
+        #   @return [String]
+        deviceId: {
+          class: :string,
+          readonly: true,
+          min_length: 1
         },
 
-        # @!attribute deviceId
-        #   @return [Integer]
-        deviceId: {
-          class: :integer
+        # @!attribute [r] objectType
+        #   @return [String]
+        objectType: {
+          class: :string,
+          readonly: true,
+          enum: OBJECT_TYPE_OPTIONS
         },
 
-        # @!attribute actions
-        #   @return [Array<Jamf::OAPISchemas::PatchPolicyAttemptAction>]
-        actions: {
-          class: Jamf::OAPISchemas::PatchPolicyAttemptAction,
-          multi: true
+        # @!attribute [r] href
+        #   @return [String]
+        href: {
+          class: :string,
+          readonly: true
         }
 
       } # end OAPI_PROPERTIES
 
-    end # class PatchPolicyAttempt
+    end # class PlanDevice
 
   end # module OAPISchemas
 

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

@@ -0,0 +1,97 @@
+# Copyright 2023 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: PlanDevicePost
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    #
+    # 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::ManagedSoftwareUpdatePlanPost
+    #
+    # 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 PlanDevicePost < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      OBJECT_TYPE_OPTIONS = [
+        'COMPUTER',
+        'MOBILE_DEVICE',
+        'APPLE_TV'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute deviceId
+        #   @return [String]
+        deviceId: {
+          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 PlanDevicePost
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,96 @@
+# Copyright 2023 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: PlanDeviceResponse
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    #
+    # 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::ManagedSoftwareUpdatePlanPostResponse
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  - Jamf::OAPISchemas::PlanDevice
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #
+    #
+    #
+    class PlanDeviceResponse < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute device
+        #   @return [Jamf::OAPISchemas::PlanDevice]
+        device: {
+          class: Jamf::OAPISchemas::PlanDevice
+        },
+
+        # @!attribute [r] planId
+        #   @return [String]
+        planId: {
+          class: :string,
+          readonly: true,
+          min_length: 1
+        },
+
+        # @!attribute [r] href
+        #   @return [String]
+        href: {
+          class: :string,
+          readonly: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class PlanDeviceResponse
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,96 @@
+# Copyright 2023 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 genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    #
+    # 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

@@ -35,7 +35,7 @@ module Jamf
     #
     #
     # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.46.0-t1681398190
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
     #
     # 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

@@ -0,0 +1,126 @@
+# Copyright 2023 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 genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    #
+    # 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',
+        '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