Class: Jamf::OAPISchemas::VolumePurchasingLocationListView

Inherits:
Jamf::OAPIObject show all
Defined in:
lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb

Overview

OAPI Object Model and Enums for: VolumePurchasingLocationListView

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

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.

Constant Summary collapse

OAPI_PROPERTIES = 
{

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

  # @!attribute [r] totalPurchasedLicenses
  #   @return [Integer]
  totalPurchasedLicenses: {
    class: :integer,
    readonly: true
  },

  # @!attribute [r] totalUsedLicenses
  #   @return [Integer]
  totalUsedLicenses: {
    class: :integer,
    readonly: true
  },

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

  # @!attribute [r] appleId
  #   @return [String]
  appleId: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] organizationName
  #   @return [String]
  organizationName: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] tokenExpiration
  #   @return [String]
  tokenExpiration: {
    class: Jamf::Timestamp,
    readonly: true
  },

  # The two-letter ISO 3166-1 code that designates the country where the Volume Purchasing account is located.
  # @!attribute [r] countryCode
  #   @return [String]
  countryCode: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] locationName
  #   @return [String]
  locationName: {
    class: :string,
    readonly: true
  },

  # If this is "true", the clientContext used by this server does not match the clientContext returned by the Volume Purchasing API.
  # @!attribute [r] clientContextMismatch
  #   @return [Boolean]
  clientContextMismatch: {
    class: :boolean,
    readonly: true
  },

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

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

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

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

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

  # @!attribute [r] lastSyncTime
  #   @return [String]
  lastSyncTime: {
    class: Jamf::Timestamp,
    readonly: true
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#appleId ⇒ String (readonly)

Returns:




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

#automaticallyPopulatePurchasedContent ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 141

#autoRegisterManagedUsers ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 153

#clientContextMismatch ⇒ Boolean (readonly)

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 133

#countryCode ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 118

#id ⇒ String (readonly)

Returns:




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

#lastSyncTime ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 171

#locationName ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 126

#name ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 69

#organizationName ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 104

#sendNotificationWhenNoLongerAssigned ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 147

#siteId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 159

#siteName ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 165

#tokenExpiration ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 111

#totalPurchasedLicenses ⇒ Integer (readonly)

Returns:

  • (Integer) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 75

#totalUsedLicenses ⇒ Integer (readonly)

Returns:

  • (Integer) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/volume_purchasing_location_list_view.rb', line 82