Class: Jamf::OAPISchemas::InventoryPreloadRecordV2

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::InventoryPreloadRecordV2

Defined in:

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

Overview

OAPI Object Model and Enums for: InventoryPreloadRecordV2

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

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

- Jamf::OAPISchemas::InventoryPreloadExtensionAttribute

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

- '/v2/inventory-preload/records:POST' needs permissions:
  - Create Inventory Preload Records
- '/v2/inventory-preload/records/{id}:GET' needs permissions:
  - Read Inventory Preload Records
- '/v2/inventory-preload/records/{id}:PUT' needs permissions:
  - Update Inventory Preload Records

Direct Known Subclasses

InventoryPreloadRecord

Constant Summary

DEVICE_TYPE_OPTIONS =

Enums used by this class or others

[
  'Computer',
  'Mobile Device',
  'Unknown'
]

OAPI_PROPERTIES =

{

  # @!attribute [r] id
  #   @return [String]
  id: {
    class: :j_id,
    identifier: :primary,
    readonly: true
  },

  # @!attribute serialNumber
  #   @return [String]
  serialNumber: {
    class: :string,
    required: true
  },

  # @!attribute deviceType
  #   @return [String]
  deviceType: {
    class: :string,
    required: true,
    enum: DEVICE_TYPE_OPTIONS
  },

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

  # @!attribute fullName
  #   @return [String]
  fullName: {
    class: :string,
    nil_ok: true
  },

  # @!attribute emailAddress
  #   @return [String]
  emailAddress: {
    class: :string,
    nil_ok: true
  },

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

  # @!attribute position
  #   @return [String]
  position: {
    class: :string,
    nil_ok: true
  },

  # @!attribute department
  #   @return [String]
  department: {
    class: :string,
    nil_ok: true
  },

  # @!attribute building
  #   @return [String]
  building: {
    class: :string,
    nil_ok: true
  },

  # @!attribute room
  #   @return [String]
  room: {
    class: :string,
    nil_ok: true
  },

  # @!attribute poNumber
  #   @return [String]
  poNumber: {
    class: :string,
    nil_ok: true
  },

  # @!attribute poDate
  #   @return [String]
  poDate: {
    class: Jamf::Timestamp,
    nil_ok: true
  },

  # @!attribute warrantyExpiration
  #   @return [String]
  warrantyExpiration: {
    class: :string,
    nil_ok: true
  },

  # @!attribute appleCareId
  #   @return [String]
  appleCareId: {
    class: :string,
    nil_ok: true
  },

  # @!attribute lifeExpectancy
  #   @return [String]
  lifeExpectancy: {
    class: :string,
    nil_ok: true
  },

  # @!attribute purchasePrice
  #   @return [String]
  purchasePrice: {
    class: :string,
    nil_ok: true
  },

  # @!attribute purchasingContact
  #   @return [String]
  purchasingContact: {
    class: :string,
    nil_ok: true
  },

  # @!attribute purchasingAccount
  #   @return [String]
  purchasingAccount: {
    class: :string,
    nil_ok: true
  },

  # @!attribute leaseExpiration
  #   @return [String]
  leaseExpiration: {
    class: :string,
    nil_ok: true
  },

  # @!attribute barCode1
  #   @return [String]
  barCode1: {
    class: :string,
    nil_ok: true
  },

  # @!attribute barCode2
  #   @return [String]
  barCode2: {
    class: :string,
    nil_ok: true
  },

  # @!attribute assetTag
  #   @return [String]
  assetTag: {
    class: :string,
    nil_ok: true
  },

  # @!attribute vendor
  #   @return [String]
  vendor: {
    class: :string,
    nil_ok: true
  },

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

}

Instance Attribute Summary

• #appleCareId ⇒ String
• #assetTag ⇒ String
• #barCode1 ⇒ String
• #barCode2 ⇒ String
• #building ⇒ String
• #department ⇒ String
• #deviceType ⇒ String
• #emailAddress ⇒ String
• #extensionAttributes ⇒ Array<Jamf::OAPISchemas::InventoryPreloadExtensionAttribute>
• #fullName ⇒ String
• #id ⇒ String readonly
• #leaseExpiration ⇒ String
• #lifeExpectancy ⇒ String
• #phoneNumber ⇒ String
• #poDate ⇒ String
• #poNumber ⇒ String
• #position ⇒ String
• #purchasePrice ⇒ String
• #purchasingAccount ⇒ String
• #purchasingContact ⇒ String
• #room ⇒ String
• #serialNumber ⇒ String
• #username ⇒ String
• #vendor ⇒ String
• #warrantyExpiration ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#appleCareId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 180

#assetTag ⇒ String

Returns:

• (String)

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

#barCode1 ⇒ String

Returns:

• (String)

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

#barCode2 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 229

#building ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 145

#department ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 138

#deviceType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 95

#emailAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 117

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

Returns:

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

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 250

#fullName ⇒ String

Returns:

• (String)

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

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 80

#leaseExpiration ⇒ String

Returns:

• (String)

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

#lifeExpectancy ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 187

#phoneNumber ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 124

#poDate ⇒ String

Returns:

• (String)

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

#poNumber ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 159

#position ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 131

#purchasePrice ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 194

#purchasingAccount ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 208

#purchasingContact ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 201

#room ⇒ String

Returns:

• (String)

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

#serialNumber ⇒ String

Returns:

• (String)

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

#username ⇒ String

Returns:

• (String)

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

#vendor ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 243

#warrantyExpiration ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/inventory_preload_record_v2.rb', line 173