Class: Jamf::OAPISchemas::SessionHistoryItemWithDetails

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::SessionHistoryItemWithDetails

Defined in:

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

Overview

OAPI Object Model and Enums for: SessionHistoryItemWithDetails

This class was automatically generated from the api/schema URL path on a Jamf Pro server version 11.6.1-t1718634702

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

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

- '/v1/jamf-remote-assist/session/{id}:GET' needs permissions:
  - Read Remote Assist
- '/v2/jamf-remote-assist/session/{id}:GET' needs permissions:
  - Read Remote Assist

Constant Summary

SESSION_TYPE_OPTIONS =

Enums used by this class or others

[
  'ATTENDED',
  'UNATTENDED'
]

STATUS_TYPE_OPTIONS =

[
  'STARTED',
  'FINISHED',
  'ERROR'
]

OAPI_PROPERTIES =

{

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

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

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

  # @!attribute sessionStartedTimestamp
  #   @return [Jamf::Timestamp]
  sessionStartedTimestamp: {
    class: Jamf::Timestamp,
    format: 'date-time'
  },

  # @!attribute sessionEndedTimestamp
  #   @return [Jamf::Timestamp]
  sessionEndedTimestamp: {
    class: Jamf::Timestamp,
    format: 'date-time'
  },

  # @!attribute sessionType
  #   @return [String]
  sessionType: {
    class: :string,
    enum: SESSION_TYPE_OPTIONS
  },

  # @!attribute statusType
  #   @return [String]
  statusType: {
    class: :string,
    enum: STATUS_TYPE_OPTIONS
  },

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

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

  # @!attribute details
  #   @return [Jamf::OAPISchemas::SessionHistoryItemDetails]
  details: {
    class: Jamf::OAPISchemas::SessionHistoryItemDetails
  }

}

Instance Attribute Summary

• #comment ⇒ String
• #details ⇒ Jamf::OAPISchemas::SessionHistoryItemDetails
• #deviceId ⇒ String
• #sessionAdminId ⇒ String
• #sessionEndedTimestamp ⇒ Jamf::Timestamp
• #sessionId ⇒ String
• #sessionStartedTimestamp ⇒ Jamf::Timestamp
• #sessionType ⇒ String
• #statusType ⇒ String
• #tenantId ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#comment ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_history_item_with_details.rb', line 135

#details ⇒ Jamf::OAPISchemas::SessionHistoryItemDetails

Returns:

• (Jamf::OAPISchemas::SessionHistoryItemDetails)

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

#deviceId ⇒ String

Returns:

• (String)

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

#sessionAdminId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_history_item_with_details.rb', line 129

#sessionEndedTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_history_item_with_details.rb', line 108

#sessionId ⇒ String

Returns:

• (String)

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

#sessionStartedTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_history_item_with_details.rb', line 101

#sessionType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_history_item_with_details.rb', line 115

#statusType ⇒ String

Returns:

• (String)

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

#tenantId ⇒ String

Returns:

• (String)

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