Class: Jamf::OAPISchemas::MobileDeviceDetails

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::MobileDeviceDetails

Defined in:

lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb

Overview

OAPI Object Model and Enums for: MobileDeviceDetails

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.

Sub Objects: Other object models used by this model’s attributes.

- Jamf::OAPISchemas::IdAndName
- Jamf::OAPISchemas::ExtensionAttribute
- Jamf::OAPISchemas::Location
- Jamf::OAPISchemas::IosDetails
- Jamf::OAPISchemas::AppleTvDetails
- Jamf::OAPISchemas::AndroidDetails

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v1/mobile-devices/{id}:PATCH' needs permissions:
  - Update Mobile Devices
- '/v1/mobile-devices/{id}/detail:GET' needs permissions:
  - Read Mobile Devices

Constant Summary

TYPE_OPTIONS =

Enums used by this class or others

[
  'ios',
  'appleTv',
  'android',
  'unknown'
]

OAPI_PROPERTIES =

{

  # @!attribute id
  #   @return [Integer]
  id: {
    class: :j_id,
    identifier: :primary
  },

  # @!attribute name
  #   @return [String]
  name: {
    class: :string
  },

  # @!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
  },

  # Collected for iOS 16 and iPadOS 16.1 or later
  # @!attribute osSupplementalBuildVersion
  #   @return [String]
  osSupplementalBuildVersion: {
    class: :string
  },

  # Collected for iOS 16 and iPadOS 16.1 or later
  # @!attribute osRapidSecurityResponse
  #   @return [String]
  osRapidSecurityResponse: {
    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 isManaged
  #   @return [Boolean]
  isManaged: {
    class: :boolean
  },

  # @!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 deviceOwnershipLevel
  #   @return [String]
  deviceOwnershipLevel: {
    class: :string
  },

  # @!attribute site
  #   @return [Jamf::OAPISchemas::IdAndName]
  site: {
    class: Jamf::OAPISchemas::IdAndName
  },

  # @!attribute extensionAttributes
  #   @return [Array<Jamf::OAPISchemas::ExtensionAttribute>]
  extensionAttributes: {
    class: Jamf::OAPISchemas::ExtensionAttribute,
    multi: true
  },

  # @!attribute location
  #   @return [Jamf::OAPISchemas::Location]
  location: {
    class: Jamf::OAPISchemas::Location
  },

  # 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::IosDetails]
  ios: {
    class: Jamf::OAPISchemas::IosDetails
  },

  # @!attribute appleTv
  #   @return [Jamf::OAPISchemas::AppleTvDetails]
  appleTv: {
    class: Jamf::OAPISchemas::AppleTvDetails
  },

  # @!attribute android
  #   @return [Jamf::OAPISchemas::AndroidDetails]
  android: {
    class: Jamf::OAPISchemas::AndroidDetails
  }

}

Instance Attribute Summary

• #android ⇒ Jamf::OAPISchemas::AndroidDetails
• #appleTv ⇒ Jamf::OAPISchemas::AppleTvDetails
• #assetTag ⇒ String
• #bluetoothMacAddress ⇒ String
• #deviceOwnershipLevel ⇒ String
• #extensionAttributes ⇒ Array<Jamf::OAPISchemas::ExtensionAttribute>
• #id ⇒ Integer
• #initialEntryTimestamp ⇒ Jamf::Timestamp
• #ios ⇒ Jamf::OAPISchemas::IosDetails
• #ipAddress ⇒ String
• #isManaged ⇒ Boolean
• #lastEnrollmentTimestamp ⇒ Jamf::Timestamp
• #lastInventoryUpdateTimestamp ⇒ Jamf::Timestamp
• #location ⇒ Jamf::OAPISchemas::Location
• #name ⇒ String
• #osBuild ⇒ String
• #osRapidSecurityResponse ⇒ String
• #osSupplementalBuildVersion ⇒ String
• #osVersion ⇒ String
• #serialNumber ⇒ String
• #site ⇒ Jamf::OAPISchemas::IdAndName
• #softwareUpdateDeviceId ⇒ String
• #type ⇒ String
• #udid ⇒ String
• #wifiMacAddress ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#android ⇒ Jamf::OAPISchemas::AndroidDetails

Returns:

• (Jamf::OAPISchemas::AndroidDetails)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 237

#appleTv ⇒ Jamf::OAPISchemas::AppleTvDetails

Returns:

• (Jamf::OAPISchemas::AppleTvDetails)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 231

#assetTag ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 97

#bluetoothMacAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 166

#deviceOwnershipLevel ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 192

#extensionAttributes ⇒ Array<Jamf::OAPISchemas::ExtensionAttribute>

Returns:

• (Array<Jamf::OAPISchemas::ExtensionAttribute>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 204

#id ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 84

#initialEntryTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 178

#ios ⇒ Jamf::OAPISchemas::IosDetails

Returns:

• (Jamf::OAPISchemas::IosDetails)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 225

#ipAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 154

#isManaged ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 172

#lastEnrollmentTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 185

#lastInventoryUpdateTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 103

#location ⇒ Jamf::OAPISchemas::Location

Returns:

• (Jamf::OAPISchemas::Location)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 211

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 91

#osBuild ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 116

#osRapidSecurityResponse ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 129

#osSupplementalBuildVersion ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 122

#osVersion ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 110

#serialNumber ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 142

#site ⇒ Jamf::OAPISchemas::IdAndName

Returns:

• (Jamf::OAPISchemas::IdAndName)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 198

#softwareUpdateDeviceId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 136

#type ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 217

#udid ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 148

#wifiMacAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details.rb', line 160