Class: Jamf::OAPISchemas::MobileDeviceDetailsV2

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::MobileDeviceDetailsV2

Defined in:

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

Overview

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

Constant Summary

TYPE_OPTIONS =

Enums used by this class or others

[
  '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
  }

}

Instance Attribute Summary

• #assetTag ⇒ String
• #bluetoothMacAddress ⇒ String
• #deviceOwnershipLevel ⇒ String
• #enforceName ⇒ Boolean
• #enrollmentMethod ⇒ String
• #extensionAttributes ⇒ Array<Jamf::OAPISchemas::ExtensionAttributeV2>
• #id ⇒ String readonly
• #initialEntryTimestamp ⇒ Jamf::Timestamp
• #ios ⇒ Jamf::OAPISchemas::IosDetailsV2
• #ipAddress ⇒ String
• #lastEnrollmentTimestamp ⇒ Jamf::Timestamp
• #lastInventoryUpdateTimestamp ⇒ Jamf::Timestamp
• #location ⇒ Jamf::OAPISchemas::LocationV2
• #managed ⇒ Boolean
• #mdmProfileExpirationTimestamp ⇒ Jamf::Timestamp
• #name ⇒ String
• #osBuild ⇒ String
• #osVersion ⇒ String
• #serialNumber ⇒ String
• #site ⇒ Jamf::OAPISchemas::V1Site
• #softwareUpdateDeviceId ⇒ String
• #timeZone ⇒ String
• #tvos ⇒ Jamf::OAPISchemas::TvOsDetails
• #type ⇒ String
• #udid ⇒ String
• #wifiMacAddress ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#assetTag ⇒ String

Returns:

• (String)

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

#bluetoothMacAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 158

#deviceOwnershipLevel ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 197

#enforceName ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 96

#enrollmentMethod ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 203

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

Returns:

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

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 215

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 81

#initialEntryTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 176

#ios ⇒ Jamf::OAPISchemas::IosDetailsV2

Returns:

• (Jamf::OAPISchemas::IosDetailsV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 236

#ipAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 146

#lastEnrollmentTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 183

#lastInventoryUpdateTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 109

#location ⇒ Jamf::OAPISchemas::LocationV2

Returns:

• (Jamf::OAPISchemas::LocationV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 222

#managed ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 164

#mdmProfileExpirationTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 190

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 89

#osBuild ⇒ String

Returns:

• (String)

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

#osVersion ⇒ String

Returns:

• (String)

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

#serialNumber ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 134

#site ⇒ Jamf::OAPISchemas::V1Site

Returns:

• (Jamf::OAPISchemas::V1Site)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 209

#softwareUpdateDeviceId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 128

#timeZone ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 170

#tvos ⇒ Jamf::OAPISchemas::TvOsDetails

Returns:

• (Jamf::OAPISchemas::TvOsDetails)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 242

#type ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 228

#udid ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 140

#wifiMacAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 152