ruby-jss 4.2.0b2 → 4.2.0

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

@@ -0,0 +1,169 @@
+# 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: ManagedSoftwareUpdatePlanToggleStatus
+    #
+    #
+    #
+    # 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::ManagedSoftwareUpdatePlanToggleStatusWrapper
+    #  - Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatusWrapper
+    #
+    # 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 ManagedSoftwareUpdatePlanToggleStatus < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      STATE_OPTIONS = [
+        'NOT_RUNNING',
+        'RUNNING',
+        'NEVER_RAN'
+      ]
+
+      EXIT_STATE_OPTIONS = [
+        'UNKNOWN',
+        'EXECUTING',
+        'COMPLETED',
+        'NOOP',
+        'FAILED',
+        'STOPPED'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # The local server time when the toggle was initiated. Null if state is NEVER_RAN
+        # @!attribute startTime
+        #   @return [String]
+        startTime: {
+          class: Jamf::Timestamp,
+          nil_ok: true
+        },
+
+        # The local server time when the toggle was completed. Null if state is NEVER_RAN
+        # @!attribute endTime
+        #   @return [String]
+        endTime: {
+          class: Jamf::Timestamp,
+          nil_ok: true
+        },
+
+        # Duration in seconds between the start time and end time. "Now" is used when end time is null. Null if state is NEVER_RAN
+        # @!attribute elapsedTime
+        #   @return [Integer]
+        elapsedTime: {
+          class: :integer,
+          nil_ok: true
+        },
+
+        # The current state of the toggle
+        # @!attribute state
+        #   @return [String]
+        state: {
+          class: :string,
+          enum: STATE_OPTIONS
+        },
+
+        # The total number of records that will be deleted
+        # @!attribute totalRecords
+        #   @return [Integer]
+        totalRecords: {
+          class: :integer,
+          format: 'int64'
+        },
+
+        # The total number of records that have been deleted
+        # @!attribute processedRecords
+        #   @return [Integer]
+        processedRecords: {
+          class: :integer,
+          format: 'int64'
+        },
+
+        # The percentage between total and completed records.
+        # @!attribute percentComplete
+        #   @return [Float]
+        percentComplete: {
+          class: :number,
+          format: 'double'
+        },
+
+        # Pretty print of total, processed, and percentage complete
+        # @!attribute formattedPercentComplete
+        #   @return [String]
+        formattedPercentComplete: {
+          class: :string
+        },
+
+        # Troubleshooting - The exit status code from the toggle processing job. "Unknown" will return when the toggle is running.
+        # @!attribute exitState
+        #   @return [String]
+        exitState: {
+          class: :string,
+          enum: EXIT_STATE_OPTIONS
+        },
+
+        # Troubleshooting - The exit message of the toggle job if it encounters an exception while running. Nominal return is an empty string
+        # @!attribute exitMessage
+        #   @return [String]
+        exitMessage: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlanToggleStatus
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan_toggle_status_wrapper.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: ManagedSoftwareUpdatePlanToggleStatusWrapper
+    #
+    #
+    #
+    # 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::ManagedSoftwareUpdatePlanToggleStatus
+    #  - Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatus
+    #
+    # 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/status:GET' needs permissions:
+    #    - Read Managed Software Updates
+    #
+    #
+    class ManagedSoftwareUpdatePlanToggleStatusWrapper < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute toggleOn
+        #   @return [Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatus]
+        toggleOn: {
+          class: Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatus,
+          required: true
+        },
+
+        # @!attribute toggleOff
+        #   @return [Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatus]
+        toggleOff: {
+          class: Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatus,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlanToggleStatusWrapper
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,102 @@
+# 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: ManagedSoftwareUpdatePlans
+    #
+    #
+    #
+    # 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::ManagedSoftwareUpdatePlan
+    #
+    # 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:GET' needs permissions:
+    #    - Read Managed Software Updates
+    #    - Read Computers
+    #    - Read Mobile Devices
+    #  - '/v1/managed-software-updates/plans/group/{id}:GET' needs permissions:
+    #    - Read Managed Software Updates
+    #    - Read Computers
+    #    - Read Smart Computer Groups
+    #    - Read Static Computer Groups
+    #    - Read Mobile Devices
+    #    - Read Smart Mobile Device Groups
+    #    - Read Static Mobile Device Groups
+    #
+    #
+    class ManagedSoftwareUpdatePlans < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer,
+          minimum: 0
+        },
+
+        # @!attribute [r] results
+        #   @return [Array<Jamf::OAPISchemas::ManagedSoftwareUpdatePlan>]
+        results: {
+          class: Jamf::OAPISchemas::ManagedSoftwareUpdatePlan,
+          readonly: true,
+          multi: true,
+          min_items: 0
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdatePlans
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,173 @@
+# 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: ManagedSoftwareUpdateStatus
+    #
+    #
+    #
+    # 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::ManagedSoftwareUpdateStatuses
+    #
+    # 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 ManagedSoftwareUpdateStatus < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      STATUS_OPTIONS = %w[
+        DOWNLOADING
+        IDLE
+        INSTALLING
+        INSTALLED
+        ERROR
+        DOWNLOAD_FAILED
+        DOWNLOAD_REQUIRES_COMPUTER
+        DOWNLOAD_INSUFFICIENT_SPACE
+        DOWNLOAD_INSUFFICIENT_POWER
+        DOWNLOAD_INSUFFICIENT_NETWORK
+        INSTALL_INSUFFICIENT_SPACE
+        INSTALL_INSUFFICIENT_POWER
+        INSTALL_PHONE_CALL_IN_PROGRESS
+        INSTALL_FAILED
+        UNKNOWN
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute osUpdatesStatusId
+        #   @return [String]
+        osUpdatesStatusId: {
+          class: :string,
+          identifier: :primary
+        },
+
+        # @!attribute device
+        #   @return [Hash{Symbol: Object}]
+        device: {
+          class: :hash
+        },
+
+        # @!attribute downloadPercentComplete
+        #   @return [Float]
+        downloadPercentComplete: {
+          class: :number
+        },
+
+        # @!attribute downloaded
+        #   @return [Boolean]
+        downloaded: {
+          class: :boolean
+        },
+
+        # @!attribute productKey
+        #   @return [String]
+        productKey: {
+          class: :string
+        },
+
+        # @!attribute status
+        #   @return [String]
+        status: {
+          class: :string,
+          enum: STATUS_OPTIONS
+        },
+
+        # not applicable to all managed software update statuses
+        # @!attribute deferralsRemaining
+        #   @return [Integer]
+        deferralsRemaining: {
+          class: :integer
+        },
+
+        # not applicable to all managed software update statuses
+        # @!attribute maxDeferrals
+        #   @return [Integer]
+        maxDeferrals: {
+          class: :integer
+        },
+
+        # not applicable to all managed software update statuses
+        # @!attribute nextScheduledInstall
+        #   @return [Jamf::Timestamp]
+        nextScheduledInstall: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # not applicable to all managed software update statuses
+        # @!attribute pastNotifications
+        #   @return [Array<Jamf::Timestamp>]
+        pastNotifications: {
+          class: Jamf::Timestamp,
+          multi: true
+        },
+
+        # @!attribute created
+        #   @return [Jamf::Timestamp]
+        created: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute updated
+        #   @return [Jamf::Timestamp]
+        updated: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdateStatus
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,102 @@
+# 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: ManagedSoftwareUpdateStatuses
+    #
+    #
+    #
+    # 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::ManagedSoftwareUpdateStatus
+    #
+    # 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/update-statuses:GET' needs permissions:
+    #    - Read Computers
+    #    - Read Mobile Devices
+    #  - '/v1/managed-software-updates/update-statuses/computer-groups/{id}:GET' needs permissions:
+    #    - Read Computers
+    #    - Read Smart Computer Groups
+    #    - Read Static Computer Groups
+    #  - '/v1/managed-software-updates/update-statuses/computers/{id}:GET' needs permissions:
+    #    - Read Computers
+    #  - '/v1/managed-software-updates/update-statuses/mobile-device-groups/{id}:GET' needs permissions:
+    #    - Read Mobile Devices
+    #    - Read Smart Mobile Device Groups
+    #    - Read Static Mobile Device Groups
+    #  - '/v1/managed-software-updates/update-statuses/mobile-devices/{id}:GET' needs permissions:
+    #    - Read Mobile Devices
+    #
+    #
+    class ManagedSoftwareUpdateStatuses < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer
+        },
+
+        # @!attribute results
+        #   @return [Array<Jamf::OAPISchemas::ManagedSoftwareUpdateStatus>]
+        results: {
+          class: Jamf::OAPISchemas::ManagedSoftwareUpdateStatus,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ManagedSoftwareUpdateStatuses
+
+  end # module OAPISchemas
+
+end # module Jamf