Class: Jamf::OAPISchemas::MobileDevice

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::MobileDevice

Defined in:

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

Overview

OAPI Object Model and Enums for: MobileDevice

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.46.0-t1681398190

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::MobileDeviceSearchResults

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-devices:GET' needs permissions:
  - Read Mobile Devices
- '/v1/mobile-devices/{id}: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 serialNumber
  #   @return [String]
  serialNumber: {
    class: :string
  },

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

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

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

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

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

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

  # @!attribute type
  #   @return [String]
  type: {
    class: :string,
    enum: TYPE_OPTIONS
  },

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

}

Instance Attribute Summary

• #id ⇒ Integer
• #model ⇒ String
• #modelIdentifier ⇒ String
• #name ⇒ String
• #phoneNumber ⇒ String
• #serialNumber ⇒ String
• #softwareUpdateDeviceId ⇒ String
• #type ⇒ String
• #udid ⇒ String
• #username ⇒ String
• #wifiMacAddress ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#id ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device.rb', line 79

#model ⇒ String

Returns:

• (String)

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

#modelIdentifier ⇒ String

Returns:

• (String)

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

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device.rb', line 86

#phoneNumber ⇒ String

Returns:

• (String)

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

#serialNumber ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device.rb', line 92

#softwareUpdateDeviceId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device.rb', line 141

#type ⇒ String

Returns:

• (String)

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

#udid ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device.rb', line 104

#username ⇒ String

Returns:

• (String)

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

#wifiMacAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device.rb', line 98