ruby-jss 1.6.0b1 → 2.0.0a10

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

@@ -0,0 +1,254 @@
+# Copyright 2022 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: MobileDeviceDetailsV2
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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::V1Site
+    #  - Jamf::OAPISchemas::ExtensionAttributeV2
+    #  - Jamf::OAPISchemas::LocationV2
+    #  - Jamf::OAPISchemas::IosDetailsV2
+    #  - Jamf::OAPISchemas::TvOsDetails
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v2/mobile-devices/{id}:PATCH' needs permissions:
+    #    - Update Mobile Devices
+    #
+    #
+    class MobileDeviceDetailsV2 < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      TYPE_OPTIONS = [
+        'ios',
+        'tvos',
+        'unknown'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute [r] id
+        #   @return [String]
+        id: {
+          class: :j_id,
+          identifier: :primary,
+          readonly: true
+        },
+
+        # Mobile device name.
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the Mobile Device Name to the ‘name’ value each time the device checks in.
+        # @!attribute enforceName
+        #   @return [Boolean]
+        enforceName: {
+          class: :boolean
+        },
+
+        # @!attribute assetTag
+        #   @return [String]
+        assetTag: {
+          class: :string
+        },
+
+        # @!attribute lastInventoryUpdateTimestamp
+        #   @return [Jamf::Timestamp]
+        lastInventoryUpdateTimestamp: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute osVersion
+        #   @return [String]
+        osVersion: {
+          class: :string
+        },
+
+        # @!attribute osBuild
+        #   @return [String]
+        osBuild: {
+          class: :string
+        },
+
+        # @!attribute softwareUpdateDeviceId
+        #   @return [String]
+        softwareUpdateDeviceId: {
+          class: :string
+        },
+
+        # @!attribute serialNumber
+        #   @return [String]
+        serialNumber: {
+          class: :string
+        },
+
+        # @!attribute udid
+        #   @return [String]
+        udid: {
+          class: :string
+        },
+
+        # @!attribute ipAddress
+        #   @return [String]
+        ipAddress: {
+          class: :string
+        },
+
+        # @!attribute wifiMacAddress
+        #   @return [String]
+        wifiMacAddress: {
+          class: :string
+        },
+
+        # @!attribute bluetoothMacAddress
+        #   @return [String]
+        bluetoothMacAddress: {
+          class: :string
+        },
+
+        # @!attribute managed
+        #   @return [Boolean]
+        managed: {
+          class: :boolean
+        },
+
+        # @!attribute timeZone
+        #   @return [String]
+        timeZone: {
+          class: :string
+        },
+
+        # @!attribute initialEntryTimestamp
+        #   @return [Jamf::Timestamp]
+        initialEntryTimestamp: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute lastEnrollmentTimestamp
+        #   @return [Jamf::Timestamp]
+        lastEnrollmentTimestamp: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute mdmProfileExpirationTimestamp
+        #   @return [Jamf::Timestamp]
+        mdmProfileExpirationTimestamp: {
+          class: Jamf::Timestamp,
+          format: 'date-time'
+        },
+
+        # @!attribute deviceOwnershipLevel
+        #   @return [String]
+        deviceOwnershipLevel: {
+          class: :string
+        },
+
+        # @!attribute enrollmentMethod
+        #   @return [String]
+        enrollmentMethod: {
+          class: :string
+        },
+
+        # @!attribute site
+        #   @return [Jamf::OAPISchemas::V1Site]
+        site: {
+          class: Jamf::OAPISchemas::V1Site
+        },
+
+        # @!attribute extensionAttributes
+        #   @return [Array<Jamf::OAPISchemas::ExtensionAttributeV2>]
+        extensionAttributes: {
+          class: Jamf::OAPISchemas::ExtensionAttributeV2,
+          multi: true
+        },
+
+        # @!attribute location
+        #   @return [Jamf::OAPISchemas::LocationV2]
+        location: {
+          class: Jamf::OAPISchemas::LocationV2
+        },
+
+        # Based on the value of this either ios, appleTv, android objects will be populated.
+        # @!attribute type
+        #   @return [String]
+        type: {
+          class: :string,
+          enum: TYPE_OPTIONS
+        },
+
+        # @!attribute ios
+        #   @return [Jamf::OAPISchemas::IosDetailsV2]
+        ios: {
+          class: Jamf::OAPISchemas::IosDetailsV2
+        },
+
+        # @!attribute tvos
+        #   @return [Jamf::OAPISchemas::TvOsDetails]
+        tvos: {
+          class: Jamf::OAPISchemas::TvOsDetails
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MobileDeviceDetailsV2
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,95 @@
+# Copyright 2022 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: MobileDeviceEbook
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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::IosDetails
+    #  - Jamf::OAPISchemas::IosDetailsV2
+    #
+    # 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 MobileDeviceEbook < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute author
+        #   @return [String]
+        author: {
+          class: :string
+        },
+
+        # @!attribute title
+        #   @return [String]
+        title: {
+          class: :string
+        },
+
+        # @!attribute version
+        #   @return [String]
+        version: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MobileDeviceEbook
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,84 @@
+# Copyright 2022 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: MobileDeviceExtensionAttributeResults
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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.
+    #  - '/devices/extensionAttributes:GET' needs permissions:
+    #    - Read Mobile Device Extension Attributes
+    #
+    #
+    class MobileDeviceExtensionAttributeResults < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute extensionAttributes
+        #   @return [Array<Hash{Symbol: Object}>]
+        extensionAttributes: {
+          class: :hash,
+          multi: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MobileDeviceExtensionAttributeResults
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,97 @@
+# Copyright 2022 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: MobileDeviceGroup
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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/mobile-device-groups:GET' needs permissions:
+    #    - Read Smart Mobile Device Groups
+    #    - Read Static Mobile Device Groups
+    #
+    #
+    class MobileDeviceGroup < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        },
+
+        # @!attribute isSmartGroup
+        #   @return [Boolean]
+        isSmartGroup: {
+          class: :boolean
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class MobileDeviceGroup
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -0,0 +1,137 @@
+# Copyright 2022 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: MobileDevicePrestage
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.36.1-t1645562643
+    #
+    # 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/mobile-device-prestages:POST' needs permissions:
+    #    - Create Mobile Device PreStage Enrollments
+    #
+    #
+    class MobileDevicePrestage < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute isAllowPairing
+        #   @return [Boolean]
+        isAllowPairing: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute isMultiUser
+        #   @return [Boolean]
+        isMultiUser: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute isSupervised
+        #   @return [Boolean]
+        isSupervised: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute maximumSharedAccounts
+        #   @return [Integer]
+        maximumSharedAccounts: {
+          class: :integer,
+          required: true
+        },
+
+        # @!attribute isAutoAdvanceSetup
+        #   @return [Boolean]
+        isAutoAdvanceSetup: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute isConfigureDeviceBeforeSetupAssistant
+        #   @return [Boolean]
+        isConfigureDeviceBeforeSetupAssistant: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute language
+        #   @return [String]
+        language: {
+          class: :string
+        },
+
+        # @!attribute region
+        #   @return [String]
+        region: {
+          class: :string
+        },
+
+        # @!attribute names
+        #   @return [Jamf::OAPISchemas::MobileDevicePrestageNames]
+        names: {
+          class: Jamf::OAPISchemas::MobileDevicePrestageNames
+        }
+
+      }.merge(Jamf::OAPISchemas::DeviceEnrollmentPrestage::OAPI_PROPERTIES) # end OAPI_PROPERTIES
+
+    end # class MobileDevicePrestage
+
+  end # module OAPISchemas
+
+end # module Jamf