Class: Jamf::OAPISchemas::EbookScope

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::EbookScope

Defined in:

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

Overview

OAPI Object Model and Enums for: EbookScope

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::EbookLimitations
- Jamf::OAPISchemas::EbookExclusions

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}/scope:GET' needs permissions:
  - Read eBooks

Constant Summary

OAPI_PROPERTIES =

{

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

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

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

  # @!attribute computerIds
  #   @return [Array<String>]
  computerIds: {
    class: :string,
    multi: true
  },

  # @!attribute computerGroupIds
  #   @return [Array<String>]
  computerGroupIds: {
    class: :string,
    multi: true
  },

  # @!attribute mobileDeviceIds
  #   @return [Array<String>]
  mobileDeviceIds: {
    class: :string,
    multi: true
  },

  # @!attribute mobileDeviceGroupIds
  #   @return [Array<String>]
  mobileDeviceGroupIds: {
    class: :string,
    multi: true
  },

  # @!attribute buildingIds
  #   @return [Array<String>]
  buildingIds: {
    class: :string,
    multi: true
  },

  # @!attribute departmentIds
  #   @return [Array<String>]
  departmentIds: {
    class: :string,
    multi: true
  },

  # @!attribute userIds
  #   @return [Array<String>]
  userIds: {
    class: :string,
    multi: true
  },

  # @!attribute userGroupIds
  #   @return [Array<String>]
  userGroupIds: {
    class: :string,
    multi: true
  },

  # @!attribute classroomIds
  #   @return [Array<String>]
  classroomIds: {
    class: :string,
    multi: true
  },

  # @!attribute limitations
  #   @return [Jamf::OAPISchemas::EbookLimitations]
  limitations: {
    class: Jamf::OAPISchemas::EbookLimitations
  },

  # @!attribute exclusions
  #   @return [Jamf::OAPISchemas::EbookExclusions]
  exclusions: {
    class: Jamf::OAPISchemas::EbookExclusions
  }

}

Instance Attribute Summary

• #allComputers ⇒ Boolean
• #allMobileDevices ⇒ Boolean
• #allUsers ⇒ Boolean
• #buildingIds ⇒ Array<String>
• #classroomIds ⇒ Array<String>
• #computerGroupIds ⇒ Array<String>
• #computerIds ⇒ Array<String>
• #departmentIds ⇒ Array<String>
• #exclusions ⇒ Jamf::OAPISchemas::EbookExclusions
• #limitations ⇒ Jamf::OAPISchemas::EbookLimitations
• #mobileDeviceGroupIds ⇒ Array<String>
• #mobileDeviceIds ⇒ Array<String>
• #userGroupIds ⇒ Array<String>
• #userIds ⇒ Array<String>

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#allComputers ⇒ Boolean

Returns:

• (Boolean)

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

#allMobileDevices ⇒ Boolean

Returns:

• (Boolean)

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

#allUsers ⇒ Boolean

Returns:

• (Boolean)

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

#buildingIds ⇒ Array<String>

Returns:

• (Array<String>)

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

#classroomIds ⇒ Array<String>

Returns:

• (Array<String>)

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

#computerGroupIds ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ebook_scope.rb', line 96

#computerIds ⇒ Array<String>

Returns:

• (Array<String>)

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

#departmentIds ⇒ Array<String>

Returns:

• (Array<String>)

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

#exclusions ⇒ Jamf::OAPISchemas::EbookExclusions

Returns:

• (Jamf::OAPISchemas::EbookExclusions)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ebook_scope.rb', line 158

#limitations ⇒ Jamf::OAPISchemas::EbookLimitations

Returns:

• (Jamf::OAPISchemas::EbookLimitations)

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

#mobileDeviceGroupIds ⇒ Array<String>

Returns:

• (Array<String>)

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

#mobileDeviceIds ⇒ Array<String>

Returns:

• (Array<String>)

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

#userGroupIds ⇒ Array<String>

Returns:

• (Array<String>)

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

#userIds ⇒ Array<String>

Returns:

• (Array<String>)

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