Class: Jamf::OAPISchemas::VolumePurchasingSubscriptionBase

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::VolumePurchasingSubscriptionBase

Defined in:

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

Overview

OAPI Object Model and Enums for: VolumePurchasingSubscriptionBase

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::InternalRecipient
- Jamf::OAPISchemas::ExternalRecipient

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

- '/v1/volume-purchasing-subscriptions:POST' needs permissions:
  - Create Volume Purchasing Locations
- '/v1/volume-purchasing-subscriptions/{id}:PUT' needs permissions:
  - Update Volume Purchasing Locations

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute name
  #   @return [String]
  name: {
    class: :string,
    required: true,
    min_length: 1
  },

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

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

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

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

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

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

}

Instance Attribute Summary

• #enabled ⇒ Boolean
• #externalRecipients ⇒ Array<Jamf::OAPISchemas::ExternalRecipient>
• #internalRecipients ⇒ Array<Jamf::OAPISchemas::InternalRecipient>
• #locationIds ⇒ Array<String>
• #name ⇒ String
• #siteId ⇒ String
• #triggers ⇒ Array<String>

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#enabled ⇒ Boolean

Returns:

• (Boolean)

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

#externalRecipients ⇒ Array<Jamf::OAPISchemas::ExternalRecipient>

Returns:

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

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

#internalRecipients ⇒ Array<Jamf::OAPISchemas::InternalRecipient>

Returns:

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

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

#locationIds ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_subscription_base.rb', line 94

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_subscription_base.rb', line 73

#siteId ⇒ String

Returns:

• (String)

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

#triggers ⇒ Array<String>

Returns:

• (Array<String>)

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