ruby-jss 5.0.2 → 5.1.0b1

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

@@ -0,0 +1,104 @@
+# 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: Category
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.9.2-t1726753918
+    #
+    # 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::CategoriesSearchResults
+    #
+    # 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/categories:POST' needs permissions:
+    #    - Create Categories
+    #  - '/v1/categories/{id}:GET' needs permissions:
+    #    - Read Categories
+    #  - '/v1/categories/{id}:PUT' needs permissions:
+    #    - Update Categories
+    #
+    #
+    class Category < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true,
+          min_length: 1
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute priority
+        #   @return [Integer]
+        priority: {
+          class: :integer,
+          required: true,
+          format: 'int32'
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class Category
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/computer_extension_attribute_search_results.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: ComputerExtensionAttributeSearchResults
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.9.2-t1726753918
+    #
+    # 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::ComputerExtensionAttributes
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v1/computer-extension-attributes:GET' needs permissions:
+    #    - Read Computer Extension Attributes
+    #
+    #
+    class ComputerExtensionAttributeSearchResults < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute totalCount
+        #   @return [Integer]
+        totalCount: {
+          class: :integer,
+          required: true
+        },
+
+        # @!attribute results
+        #   @return [Array<Jamf::OAPISchemas::ComputerExtensionAttributes>]
+        results: {
+          class: Jamf::OAPISchemas::ComputerExtensionAttributes,
+          multi: true,
+          min_items: 0
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ComputerExtensionAttributeSearchResults
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,149 @@
+# 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: ComputerExtensionAttributes
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.9.2-t1726753918
+    #
+    # 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::ComputerExtensionAttributeSearchResults
+    #
+    # 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/computer-extension-attributes:POST' needs permissions:
+    #    - Create Computer Extension Attributes
+    #  - '/v1/computer-extension-attributes/{id}:GET' needs permissions:
+    #    - Read Computer Extension Attributes
+    #  - '/v1/computer-extension-attributes/{id}:PUT' needs permissions:
+    #    - Update Computer Extension Attributes
+    #
+    #
+    class ComputerExtensionAttributes < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      INVENTORY_DISPLAY_TYPE_OPTIONS = %w[
+        GENERAL
+        HARDWARE
+        OPERATING_SYSTEM
+        USER_AND_LOCATION
+        PURCHASING
+        EXTENSION_ATTRIBUTES
+      ]
+
+      INPUT_TYPE_OPTIONS = %w[
+        SCRIPT
+        TEXT
+        POPUP
+        DIRECTORY_SERVICE_ATTRIBUTE_MAPPING
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # Enabled by default, but for inputType Script we can disable it as well. <br/> Possible values are:<br/> false <br/> true
+        # @!attribute enabled
+        #   @return [Boolean]
+        enabled: {
+          class: :boolean
+        },
+
+        # Category in which to display the extension attribute in Jamf Pro.
+        # @!attribute inventoryDisplayType
+        #   @return [String]
+        inventoryDisplayType: {
+          class: :string,
+          required: true,
+          enum: INVENTORY_DISPLAY_TYPE_OPTIONS
+        },
+
+        # Extension attributes collect inventory data by using an input type.The type of the Input used to populate the extension attribute.
+        # @!attribute inputType
+        #   @return [String]
+        inputType: {
+          class: :string,
+          required: true,
+          enum: INPUT_TYPE_OPTIONS
+        },
+
+        # When we run this script it returns a data value each time a computer submits inventory to Jamf Pro. Provide scriptContents only when inputType is 'SCRIPT'.
+        # @!attribute scriptContents
+        #   @return [String]
+        scriptContents: {
+          class: :string,
+          nil_ok: true
+        },
+
+        # When added with list of choices while creating computer extension attributes these Pop-up menu can be displayed in inventory information. User can choose a value from the pop-up menu list when enrolling a computer any time using Jamf Pro. Provide popupMenuChoices only when inputType is 'POPUP'.
+        # @!attribute popupMenuChoices
+        #   @return [Array<String>]
+        popupMenuChoices: {
+          class: :string,
+          multi: true,
+          min_items: 0
+        },
+
+        # Directory Service attribute use to populate the extension attribute. <br/> Required when inputType is "DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"
+        # @!attribute ldapAttributeMapping
+        #   @return [String]
+        ldapAttributeMapping: {
+          class: :string
+        },
+
+        # Collect multiple values for this extension attribute. ldapExtensionAttributeAllowed is disabled by default, only for inputType 'DIRECTORY_SERVICE_ATTRIBUTE_MAPPING' it can be enabled. It's value cannot be modified during edit operation.<br/> Possible values are:<br/> false <br/> true <br/>
+        # @!attribute ldapExtensionAttributeAllowed
+        #   @return [Boolean]
+        ldapExtensionAttributeAllowed: {
+          class: :boolean
+        }
+      }.merge(Jamf::OAPISchemas::ExtensionAttributes::OAPI_PROPERTIES) # end OAPI_PROPERTIES
+
+    end # class ComputerExtensionAttributes
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,114 @@
+# 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: ExtensionAttributes
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.9.2-t1726753918
+    #
+    # 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.
+    #
+    #
+    #
+    class ExtensionAttributes < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      DATA_TYPE_OPTIONS = [
+        'INTEGER',
+        'STRING',
+        'DATE'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # Unique Id for Computer Extension Attribute.
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true
+        },
+
+        # Display name for the extension attribute.
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string,
+          required: true
+        },
+
+        # Description for the extension attribute.
+        # @!attribute description
+        #   @return [String]
+        description: {
+          class: :string
+        },
+
+        # Type of data being collected.
+        # @!attribute dataType
+        #   @return [String]
+        dataType: {
+          class: :string,
+          required: true,
+          enum: DATA_TYPE_OPTIONS
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class ExtensionAttributes
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,125 @@
+# 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: JamfProtectPlan
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.9.2-t1726753918
+    #
+    # 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::PlanSearchResults
+    #
+    # 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 JamfProtectPlan < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] uuid
+        #   @return [String]
+        uuid: {
+          class: :string,
+          readonly: true
+        },
+
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true
+        },
+
+        # @!attribute [r] name
+        #   @return [String]
+        name: {
+          class: :string,
+          readonly: true
+        },
+
+        # @!attribute [r] description
+        #   @return [String]
+        description: {
+          class: :string,
+          readonly: true
+        },
+
+        # @!attribute [r] profileId
+        #   @return [Integer]
+        profileId: {
+          class: :integer,
+          readonly: true
+        },
+
+        # @!attribute [r] profileName
+        #   @return [String]
+        profileName: {
+          class: :string,
+          readonly: true
+        },
+
+        # @!attribute [r] scopeDescription
+        #   @return [String]
+        scopeDescription: {
+          class: :string,
+          readonly: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class JamfProtectPlan
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,125 @@
+# 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: MobileDeviceExtensionAttribute
+    #
+    #
+    #
+    # This class was automatically generated from the api/schema
+    # URL path on a Jamf Pro server version 11.9.2-t1726753918
+    #
+    # 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::MobileDeviceGeneral
+    #  - Jamf::OAPISchemas::MobileDeviceHardware
+    #  - Jamf::OAPISchemas::MobileDeviceInventory
+    #  - Jamf::OAPISchemas::MobileDevicePurchasing
+    #  - Jamf::OAPISchemas::MobileDeviceUserAndLocation
+    #
+    # 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 MobileDeviceExtensionAttribute < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      TYPE_OPTIONS = [
+        'STRING',
+        'INTEGER',
+        'DATE'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute type
+        #   @return [String]
+        type: {
+          class: :string,
+          enum: TYPE_OPTIONS
+        },
+
+        # @!attribute value
+        #   @return [Array<String>]
+        value: {
+          class: :string,
+          multi: true
+        },
+
+        # @!attribute extensionAttributeCollectionAllowed
+        #   @return [Boolean]
+        extensionAttributeCollectionAllowed: {
+          class: :boolean
+        },
+
+        # @!attribute inventoryDisplay
+        #   @return [String]
+        inventoryDisplay: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MobileDeviceExtensionAttribute
+
+  end # module OAPISchemas
+
+end # module Jamf