Class: Jamf::OAPISchemas::NotificationV1

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::NotificationV1

Defined in:

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

Overview

OAPI Object Model and Enums for: NotificationV1

Description of this class from the OAPI Schema:

Jamf Pro notification used for important alerts.

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

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

- '/v1/notifications:GET' needs permissions:
  - Unknown

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute type
  #   @return [Jamf::OAPISchemas::NotificationType]
  type: {
    class: Jamf::OAPISchemas::NotificationType
  },

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

  # @!attribute params
  #   @return [Hash{Symbol: Hash{Symbol: Object} }]
  params: {
    class: :hash
  }

}

Instance Attribute Summary

• #id ⇒ String
• #params ⇒ Hash{Symbol: Hash{Symbol: Object} }
• #type ⇒ Jamf::OAPISchemas::NotificationType

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#id ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/notification_v1.rb', line 77

#params ⇒ Hash{Symbol: Hash{Symbol: Object} }

Returns:

• (Hash{Symbol: Hash{Symbol: Object} })

# File 'lib/jamf/api/jamf_pro/oapi_schemas/notification_v1.rb', line 84

#type ⇒ Jamf::OAPISchemas::NotificationType

Returns:

• (Jamf::OAPISchemas::NotificationType)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/notification_v1.rb', line 71