Class: Jamf::OAPISchemas::VppTokenSubscription

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::VppTokenSubscription

Defined in:

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

Overview

OAPI Object Model and Enums for: VppTokenSubscription

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.36.1-t1645562643

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::Recipients
- Jamf::OAPISchemas::AdminAccount

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

- '/vpp/subscriptions:GET' needs permissions:
  - Read Volume Purchasing Administrator Accounts
- '/vpp/subscriptions/{id}:GET' needs permissions:
  - Read Volume Purchasing Administrator Accounts

Constant Summary

OAPI_PROPERTIES =

{

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

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

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

  # @!attribute recipients
  #   @return [Jamf::OAPISchemas::Recipients]
  recipients: {
    class: Jamf::OAPISchemas::Recipients
  },

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

  # @!attribute siteID
  #   @return [Integer]
  siteID: {
    class: :integer
  },

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

}

Instance Attribute Summary

• #adminAccounts ⇒ Array<Jamf::OAPISchemas::AdminAccount>
• #enabled ⇒ Boolean
• #id ⇒ Integer
• #name ⇒ String
• #recipients ⇒ Jamf::OAPISchemas::Recipients
• #siteID ⇒ Integer
• #siteName ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#adminAccounts ⇒ Array<Jamf::OAPISchemas::AdminAccount>

Returns:

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

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_token_subscription.rb', line 99

#enabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_token_subscription.rb', line 87

#id ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_token_subscription.rb', line 74

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_token_subscription.rb', line 81

#recipients ⇒ Jamf::OAPISchemas::Recipients

Returns:

• (Jamf::OAPISchemas::Recipients)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_token_subscription.rb', line 93

#siteID ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_token_subscription.rb', line 106

#siteName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_token_subscription.rb', line 112