Class: Jamf::OAPISchemas::Ebook

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::Ebook

Defined in:

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

Overview

OAPI Object Model and Enums for: Ebook

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.

- Jamf::OAPISchemas::EbookSearchResults

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.

- '/v1/ebooks/{id}:GET' needs permissions:
  - Read eBooks

Constant Summary

KIND_OPTIONS =

Enums used by this class or others

[
  'UNKNOWN',
  'PDF',
  'EPUB',
  'IBOOKS'
]

OAPI_PROPERTIES =

{

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

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

  # @!attribute kind
  #   @return [String]
  kind: {
    class: :string,
    enum: KIND_OPTIONS
  },

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

  # @!attribute free
  #   @return [Boolean]
  free: {
    class: :boolean
  },

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

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

  # If true, it will be automatically installed
  # @!attribute deployAsManaged
  #   @return [Boolean]
  deployAsManaged: {
    class: :boolean
  },

  # @!attribute installAutomatically
  #   @return [Boolean]
  installAutomatically: {
    class: :boolean
  },

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

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

}

Instance Attribute Summary

• #author ⇒ String
• #categoryId ⇒ String
• #deployAsManaged ⇒ Boolean
• #free ⇒ Boolean
• #id ⇒ String
• #installAutomatically ⇒ Boolean
• #kind ⇒ String
• #name ⇒ String
• #siteId ⇒ String
• #url ⇒ String
• #version ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#author ⇒ String

Returns:

• (String)

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

#categoryId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ebook.rb', line 134

#deployAsManaged ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ebook.rb', line 121

#free ⇒ Boolean

Returns:

• (Boolean)

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

#id ⇒ String

Returns:

• (String)

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

#installAutomatically ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ebook.rb', line 128

#kind ⇒ String

Returns:

• (String)

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

#name ⇒ String

Returns:

• (String)

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

#siteId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ebook.rb', line 140

#url ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ebook.rb', line 97

#version ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ebook.rb', line 109