ruby-jss 4.2.0b2 → 4.2.0

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

@@ -0,0 +1,181 @@
+# 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: ManagedSoftwareUpdatePlan
+    #
+    #
+    #
+    # 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::ManagedSoftwareUpdatePlans
+    #
+    # Sub Objects:
+    # Other object models used by this model's attributes.
+    #  - Jamf::OAPISchemas::PlanDevice
+    #  - Jamf::OAPISchemas::PlanStatus
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/managed-software-updates/plans/{id}:GET' needs permissions:
+    #    - Read Managed Software Updates
+    #    - Read Computers
+    #    - Read Mobile Devices
+    #
+    #
+    class ManagedSoftwareUpdatePlan < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      UPDATE_ACTION_OPTIONS = %w[
+        DOWNLOAD_ONLY
+        DOWNLOAD_INSTALL
+        DOWNLOAD_INSTALL_ALLOW_DEFERRAL
+        DOWNLOAD_INSTALL_RESTART
+        DOWNLOAD_INSTALL_SCHEDULE
+        UNKNOWN
+      ]
+
+      VERSION_TYPE_OPTIONS = %w[
+        LATEST_MAJOR
+        LATEST_MINOR
+        LATEST_ANY
+        SPECIFIC_VERSION
+        CUSTOM_VERSION
+        UNKNOWN
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # NOTE: Manually added 'identifier: :primary'
+        # @!attribute [r] planUuid
+        #   @return [String]
+        planUuid: {
+          class: :string,
+          required: true,
+          readonly: true,
+          min_length: 1,
+          identifier: :primary
+        },
+
+        # @!attribute device
+        #   @return [Jamf::OAPISchemas::PlanDevice]
+        device: {
+          class: Jamf::OAPISchemas::PlanDevice,
+          required: true
+        },
+
+        # @!attribute [r] updateAction
+        #   @return [String]
+        updateAction: {
+          class: :string,
+          required: true,
+          readonly: true,
+          enum: UPDATE_ACTION_OPTIONS
+        },
+
+        # @!attribute [r] versionType
+        #   @return [String]
+        versionType: {
+          class: :string,
+          required: true,
+          readonly: true,
+          enum: VERSION_TYPE_OPTIONS
+        },
+
+        # 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 [r] specificVersion
+        #   @return [String]
+        specificVersion: {
+          class: :string,
+          readonly: true
+        },
+
+        # Optional. Indicates the build version to update to. Only available when the version type is set to custom version.
+        # @!attribute [r] buildVersion
+        #   @return [String]
+        buildVersion: {
+          class: :string,
+          nil_ok: true,
+          readonly: true
+        },
+
+        # Not applicable to all managed software update plans
+        # @!attribute [r] maxDeferrals
+        #   @return [Integer]
+        maxDeferrals: {
+          class: :integer,
+          required: true,
+          readonly: true,
+          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
+        },
+
+        # The id of the recipe that was used to generate the plan.
+        # @!attribute [r] recipeId
+        #   @return [String]
+        recipeId: {
+          class: :string,
+          readonly: true
+        },
+
+        # @!attribute status
+        #   @return [Jamf::OAPISchemas::PlanStatus]
+        status: {
+          class: Jamf::OAPISchemas::PlanStatus,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlan
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,85 @@
+# 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: ManagedSoftwareUpdatePlanEventStore
+    #
+    #
+    #
+    # 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.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/managed-software-updates/plans/{id}/events:GET' needs permissions:
+    #    - Read Managed Software Updates
+    #    - Read Computers
+    #    - Read Mobile Devices
+    #
+    #
+    class ManagedSoftwareUpdatePlanEventStore < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] events
+        #   @return [String]
+        events: {
+          class: :string,
+          readonly: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlanEventStore
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,99 @@
+# 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: ManagedSoftwareUpdatePlanGroupPost
+    #
+    #
+    #
+    # 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::PlanGroupPost
+    #  - Jamf::OAPISchemas::PlanConfigurationPost
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/managed-software-updates/plans/group:POST' needs permissions:
+    #    - Create Managed Software Updates
+    #    - Read Computers
+    #    - Read Mobile Devices
+    #    - Read Smart Computer Groups
+    #    - Read Static Computer Groups
+    #    - Read Smart Mobile Device Groups
+    #    - Read Static Mobile Device Groups
+    #    - Send Computer Remote Command to Download and Install OS X Update
+    #    - Send Mobile Device Remote Command to Download and Install iOS Update
+    #
+    #
+    class ManagedSoftwareUpdatePlanGroupPost < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute group
+        #   @return [Jamf::OAPISchemas::PlanGroupPost]
+        group: {
+          class: Jamf::OAPISchemas::PlanGroupPost,
+          required: true
+        },
+
+        # @!attribute config
+        #   @return [Jamf::OAPISchemas::PlanConfigurationPost]
+        config: {
+          class: Jamf::OAPISchemas::PlanConfigurationPost,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlanGroupPost
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,98 @@
+# 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: ManagedSoftwareUpdatePlanPost
+    #
+    #
+    #
+    # 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::PlanDevicePost
+    #  - Jamf::OAPISchemas::PlanConfigurationPost
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/managed-software-updates/plans:POST' needs permissions:
+    #    - Create Managed Software Updates
+    #    - Read Computers
+    #    - Read Mobile Devices
+    #    - Send Computer Remote Command to Download and Install OS X Update
+    #    - Send Mobile Device Remote Command to Download and Install iOS Update
+    #
+    #
+    class ManagedSoftwareUpdatePlanPost < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute devices
+        #   @return [Array<Jamf::OAPISchemas::PlanDevicePost>]
+        devices: {
+          class: Jamf::OAPISchemas::PlanDevicePost,
+          required: true,
+          multi: true,
+          min_items: 1,
+          unique_items: true
+        },
+
+        # @!attribute config
+        #   @return [Jamf::OAPISchemas::PlanConfigurationPost]
+        config: {
+          class: Jamf::OAPISchemas::PlanConfigurationPost,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlanPost
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,100 @@
+# 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: ManagedSoftwareUpdatePlanPostResponse
+    #
+    #
+    #
+    # 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::PlanDeviceResponse
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/managed-software-updates/plans:POST' needs permissions:
+    #    - Create Managed Software Updates
+    #    - Read Computers
+    #    - Read Mobile Devices
+    #    - Send Computer Remote Command to Download and Install OS X Update
+    #    - Send Mobile Device Remote Command to Download and Install iOS Update
+    #  - '/v1/managed-software-updates/plans/group:POST' needs permissions:
+    #    - Create Managed Software Updates
+    #    - Read Computers
+    #    - Read Mobile Devices
+    #    - Read Smart Computer Groups
+    #    - Read Static Computer Groups
+    #    - Read Smart Mobile Device Groups
+    #    - Read Static Mobile Device Groups
+    #    - Send Computer Remote Command to Download and Install OS X Update
+    #    - Send Mobile Device Remote Command to Download and Install iOS Update
+    #
+    #
+    class ManagedSoftwareUpdatePlanPostResponse < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] plans
+        #   @return [Array<Jamf::OAPISchemas::PlanDeviceResponse>]
+        plans: {
+          class: Jamf::OAPISchemas::PlanDeviceResponse,
+          readonly: true,
+          multi: true,
+          min_items: 0,
+          unique_items: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlanPostResponse
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,115 @@
+# 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: ManagedSoftwareUpdatePlanToggle
+    #
+    #
+    #
+    # 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.
+    #  
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/managed-software-updates/plans/feature-toggle:GET' needs permissions:
+    #    - Read Managed Software Updates
+    #  - '/v1/managed-software-updates/plans/feature-toggle:PUT' needs permissions:
+    #    - Read Managed Software Updates
+    #    - Create Managed Software Updates
+    #    - Update Managed Software Updates
+    #
+    #
+    class ManagedSoftwareUpdatePlanToggle < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute toggle
+        #   @return [Boolean]
+        toggle: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute [r] forceInstallLocalDateEnabled
+        #   @return [Boolean]
+        forceInstallLocalDateEnabled: {
+          class: :boolean,
+          readonly: true
+        },
+
+        # @!attribute [r] customVersionEnabled
+        #   @return [Boolean]
+        customVersionEnabled: {
+          class: :boolean,
+          readonly: true
+        },
+
+        # @!attribute [r] dssEnabled
+        #   @return [Boolean]
+        dssEnabled: {
+          class: :boolean,
+          readonly: true
+        },
+
+        # @!attribute [r] recipeEnabled
+        #   @return [Boolean]
+        recipeEnabled: {
+          class: :boolean,
+          readonly: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlanToggle
+
+  end # module OAPISchemas
+
+end # module Jamf