Class: Jamf::OAPISchemas::UpdateMobileDeviceV2

Inherits:
Jamf::OAPIObject show all
Defined in:
lib/jamf/api/jamf_pro/oapi_schemas/update_mobile_device_v2.rb

Overview

OAPI Object Model and Enums for: UpdateMobileDeviceV2

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::LocationV2
- Jamf::OAPISchemas::ExtensionAttributeV2
- Jamf::OAPISchemas::UpdateIosV2
- Jamf::OAPISchemas::UpdateTvOs

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 collapse

OAPI_PROPERTIES = 
{

  # Mobile Device Name. When updated, Jamf Pro sends an MDM settings command to the device (device must be supervised).
  # @!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 siteId
  #   @return [String]
  siteId: {
    class: :string
  },

  # IANA time zone database name
  # @!attribute timeZone
  #   @return [String]
  timeZone: {
    class: :string
  },

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

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

  # @!attribute ios
  #   @return [Jamf::OAPISchemas::UpdateIosV2]
  ios: {
    class: Jamf::OAPISchemas::UpdateIosV2
  },

  # @!attribute tvos
  #   @return [Jamf::OAPISchemas::UpdateTvOs]
  tvos: {
    class: Jamf::OAPISchemas::UpdateTvOs
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#assetTag ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/update_mobile_device_v2.rb', line 88

#enforceName ⇒ Boolean

Returns:

  • (Boolean) 



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

#ios ⇒ Jamf::OAPISchemas::UpdateIosV2

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/update_mobile_device_v2.rb', line 120

#location ⇒ Jamf::OAPISchemas::LocationV2

Returns:




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

#name ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/update_mobile_device_v2.rb', line 74

#siteId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/update_mobile_device_v2.rb', line 94

#timeZone ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/update_mobile_device_v2.rb', line 100

#tvos ⇒ Jamf::OAPISchemas::UpdateTvOs

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/update_mobile_device_v2.rb', line 126

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

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/update_mobile_device_v2.rb', line 113