Class: Jamf::OAPISchemas::Building

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

Overview

OAPI Object Model and Enums for: Building

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

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/buildings:POST' needs permissions:
  - Create Buildings
- '/v1/buildings/{id}:GET' needs permissions:
  - Read Buildings
- '/v1/buildings/{id}:PUT' needs permissions:
  - Update Buildings

Direct Known Subclasses

JpBuilding

Constant Summary collapse

OAPI_PROPERTIES = 
{

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

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

  # @!attribute streetAddress1
  #   @return [String]
  streetAddress1: {
    class: :string,
    nil_ok: true
  },

  # @!attribute streetAddress2
  #   @return [String]
  streetAddress2: {
    class: :string,
    nil_ok: true
  },

  # @!attribute city
  #   @return [String]
  city: {
    class: :string,
    nil_ok: true
  },

  # @!attribute stateProvince
  #   @return [String]
  stateProvince: {
    class: :string,
    nil_ok: true
  },

  # @!attribute zipPostalCode
  #   @return [String]
  zipPostalCode: {
    class: :string,
    nil_ok: true
  },

  # @!attribute country
  #   @return [String]
  country: {
    class: :string,
    nil_ok: true
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#city ⇒ String

Returns:




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

#country ⇒ String

Returns:




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

#id ⇒ String (readonly)

Returns:




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

#name ⇒ String

Returns:




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

#stateProvince ⇒ String

Returns:




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

#streetAddress1 ⇒ String

Returns:




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

#streetAddress2 ⇒ String

Returns:




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

#zipPostalCode ⇒ String

Returns:




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