Class: Jamf::OAPISchemas::EraseDeviceCommand

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::EraseDeviceCommand

Defined in:

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

Overview

OAPI Object Model and Enums for: EraseDeviceCommand

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.

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

Constant Summary

OBLITERATION_BEHAVIOR_OPTIONS =

Enums used by this class or others

[
  'Default',
  'DoNotObliterate',
  'ObliterateWithWarning',
  'Always'
]

OAPI_PROPERTIES =

{

  # If true, preserve the data plan on an iPhone or iPad with eSIM functionality, if one exists. This value is available in iOS 11 and later.
  # @!attribute preserveDataPlan
  #   @return [Boolean]
  preserveDataPlan: {
    class: :boolean
  },

  # If true, disable Proximity Setup on the next reboot and skip the pane in Setup Assistant. This value is available in iOS 11 and later. Prior to iOS 14, don’t use this option with any other option.
  # @!attribute disallowProximitySetup
  #   @return [Boolean]
  disallowProximitySetup: {
    class: :boolean
  },

  # The six-character PIN for Find My. This value is available in macOS 10.8 and later.
  # @!attribute pin
  #   @return [String]
  pin: {
    class: :string,
    min_length: 6,
    max_length: 6
  },

  # This key defines the fallback behavior for erasing a device.
  # @!attribute obliterationBehavior
  #   @return [String]
  obliterationBehavior: {
    class: :string,
    enum: OBLITERATION_BEHAVIOR_OPTIONS
  },

  # The configuration settings for Return to Service.
  # @!attribute returnToService
  #   @return [Hash{Symbol: Object}]
  returnToService: {
    class: :hash
  }

}

Instance Attribute Summary

• #disallowProximitySetup ⇒ Boolean
• #obliterationBehavior ⇒ String
• #pin ⇒ String
• #preserveDataPlan ⇒ Boolean
• #returnToService ⇒ Hash{Symbol: Object}

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#disallowProximitySetup ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/erase_device_command.rb', line 83

#obliterationBehavior ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/erase_device_command.rb', line 99

#pin ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/erase_device_command.rb', line 90

#preserveDataPlan ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/erase_device_command.rb', line 76

#returnToService ⇒ Hash{Symbol: Object}

Returns:

• (Hash{Symbol: Object})

# File 'lib/jamf/api/jamf_pro/oapi_schemas/erase_device_command.rb', line 107