portfoliomanager-rb 0.0.1

data/lib/portfolio_manager/services/property_use.rb

@@ -0,0 +1,306 @@
+require "net/http"
+
+module PortfolioManager
+  module Services
+    # Property Use Services
+    #
+    # The Property Use Services allows you to define how a property will be used
+    # and operated. These services allow you to add, update, and delete the use
+    # types of a property as well as manage their operating characteristics.
+    #
+    # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse
+    module PropertyUse
+      # Property Use
+      module PropertyUse
+        # Live Environment
+        module Live
+          # Add Property Use
+          #
+          # This web service creates a property use under a specified property
+          # based on the information provided in the XML request. It returns the
+          # unique identifier to the newly created property use and a link to
+          # the corresponding web service to retrieve it. To specify the use of
+          # default values, just omit the "value" XML tag for that particular
+          # use detail information from the XML request or omit the entire
+          # reference to the particular use detail information from the XML
+          # request altogether.
+          #
+          # @param property_id [Integer]
+          # @param property_use [PortfolioManager::Xml::BankBranchType, PortfolioManager::Xml::BarracksType, PortfolioManager::Xml::CollegeUniversityType, PortfolioManager::Xml::ConvenienceStoreWithGasStationType, PortfolioManager::Xml::ConvenienceStoreWithoutGasStationType, PortfolioManager::Xml::CourthouseType, PortfolioManager::Xml::DataCenterType, PortfolioManager::Xml::DistributionCenterType, PortfolioManager::Xml::DrinkingWaterTreatmentAndDistributionType, PortfolioManager::Xml::FinancialOfficeType, PortfolioManager::Xml::FoodSalesType, PortfolioManager::Xml::HospitalType, PortfolioManager::Xml::HotelType, PortfolioManager::Xml::IceCurlingRinkType, PortfolioManager::Xml::IndoorArenaType, PortfolioManager::Xml::K12SchoolType, PortfolioManager::Xml::MedicalOfficeType, PortfolioManager::Xml::MultifamilyHousingType, PortfolioManager::Xml::NonRefrigeratedWarehouseType, PortfolioManager::Xml::OfficeType, PortfolioManager::Xml::OtherStadiumType, PortfolioManager::Xml::ParkingType, PortfolioManager::Xml::RefrigeratedWarehouseType, PortfolioManager::Xml::ResidenceHallDormitoryType, PortfolioManager::Xml::ResidentialCareFacilityType, PortfolioManager::Xml::RetailType, PortfolioManager::Xml::SelfStorageFacilityType, PortfolioManager::Xml::SeniorLivingCommunityType, PortfolioManager::Xml::SingleFamilyHomeType, PortfolioManager::Xml::StadiumClosedType, PortfolioManager::Xml::StadiumOpenType, PortfolioManager::Xml::SupermarketType, PortfolioManager::Xml::SwimmingPoolType, PortfolioManager::Xml::WastewaterTreatmentPlantType, PortfolioManager::Xml::WholesaleClubSupercenterType, PortfolioManager::Xml::WorshipFacilityType]
+          # @param elename [nil, String]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/propertyUse/post
+          def add_property_use(property_id, property_use, elename = nil)
+            request(Net::HTTP::Post, path_for("property", property_id, "propertyUse"), {}, {}, property_use, elename, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Delete Property Use
+          #
+          # This web service deletes a specific property use. The corresponding
+          # property must already be shared with you.
+          #
+          # @param property_use_id [Integer]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/propertyUse/delete
+          def delete_property_use(property_use_id)
+            request(Net::HTTP::Delete, path_for("propertyUse", property_use_id), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Edit Property Use
+          #
+          # This web service updates a specific property use under a given
+          # property based on the information provided in the XML request. Only
+          # the name of the property use can be updated with this web service.
+          # It returns the unique identifier to the property use and a link to
+          # the corresponding web service to retrieve it. The corresponding
+          # property must already be shared with you.
+          #
+          # @param property_use_id [Integer]
+          # @param property_use [PortfolioManager::Xml::PropertyUse]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/propertyUse/put
+          def edit_property_use(property_use_id, property_use)
+            request(Net::HTTP::Put, path_for("propertyUse", property_use_id), {}, {}, property_use, "propertyUse", PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Get ID Hierarchy for Property Use
+          #
+          # This web service returns the accountId and propertyId that
+          # corresponds to a specific property use. The accountId returned is
+          # the Property Data Administrator (PDA). The corresponding property
+          # must already be shared with you or you must have pending share
+          # access.
+          #
+          # @param property_use_id [Integer]
+          # @return [PortfolioManager::Xml::HierarchyType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/hierarchy/get
+          def get_id_hierarchy_for_property_use(property_use_id)
+            request(Net::HTTP::Get, path_for("idHierarchy", "propertyUse", property_use_id), {}, {}, nil, nil, PortfolioManager::Xml::HierarchyType, basic_auth: true)
+          end
+
+          # Get Property Use
+          #
+          # This web service returns information for a specific property use.
+          # The information includes general data about the property use itself
+          # and its most current operating characteristics information. If the
+          # "value" XML tag is not present, then no value was initially provided
+          # for that operating characteristic. The corresponding property must
+          # already be shared with you.
+          #
+          # @param property_use_id [Integer]
+          # @param klass [nil, Class]
+          # @return [PortfolioManager::Xml::BankBranchType, PortfolioManager::Xml::BarracksType, PortfolioManager::Xml::CollegeUniversityType, PortfolioManager::Xml::ConvenienceStoreWithGasStationType, PortfolioManager::Xml::ConvenienceStoreWithoutGasStationType, PortfolioManager::Xml::CourthouseType, PortfolioManager::Xml::DataCenterType, PortfolioManager::Xml::DistributionCenterType, PortfolioManager::Xml::DrinkingWaterTreatmentAndDistributionType, PortfolioManager::Xml::FinancialOfficeType, PortfolioManager::Xml::FoodSalesType, PortfolioManager::Xml::HospitalType, PortfolioManager::Xml::HotelType, PortfolioManager::Xml::IceCurlingRinkType, PortfolioManager::Xml::IndoorArenaType, PortfolioManager::Xml::K12SchoolType, PortfolioManager::Xml::MedicalOfficeType, PortfolioManager::Xml::MultifamilyHousingType, PortfolioManager::Xml::NonRefrigeratedWarehouseType, PortfolioManager::Xml::OfficeType, PortfolioManager::Xml::OtherStadiumType, PortfolioManager::Xml::ParkingType, PortfolioManager::Xml::RefrigeratedWarehouseType, PortfolioManager::Xml::ResidenceHallDormitoryType, PortfolioManager::Xml::ResidentialCareFacilityType, PortfolioManager::Xml::RetailType, PortfolioManager::Xml::SelfStorageFacilityType, PortfolioManager::Xml::SeniorLivingCommunityType, PortfolioManager::Xml::SingleFamilyHomeType, PortfolioManager::Xml::StadiumClosedType, PortfolioManager::Xml::StadiumOpenType, PortfolioManager::Xml::SupermarketType, PortfolioManager::Xml::SwimmingPoolType, PortfolioManager::Xml::WastewaterTreatmentPlantType, PortfolioManager::Xml::WholesaleClubSupercenterType, PortfolioManager::Xml::WorshipFacilityType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/propertyUse/get
+          def get_property_use(property_use_id, klass = nil)
+            request(Net::HTTP::Get, path_for("propertyUse", property_use_id), {}, {}, nil, nil, klass, basic_auth: true)
+          end
+
+          # Get Property Use List
+          #
+          # This web service returns the list of property uses for a specific
+          # property. The property must already be shared with you.
+          #
+          # @param property_id [Integer]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/propertyUseList/get
+          def get_property_use_list(property_id)
+            request(Net::HTTP::Get, path_for("property", property_id, "propertyUse", "list"), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Get What Changed Property Use List
+          #
+          # This web service returns a list of property uses that had their name
+          # or use details modified since a user specified date. The list of
+          # property uses returned are account specific. Results are returned in
+          # increments of 1,000 per set. The returned list only shows property
+          # uses that you have permission to view. Actions that trigger a
+          # property use to be included in the returned list may have been
+          # performed by any user with property use access. Changes that result
+          # in a property use being returned are as follows:
+          # - a use detail within the property use is corrected or updated with
+          #   a new historical record
+          # - the name of the property use is edited
+          #
+          # @param customer_id [Integer]
+          # @param date [Date]
+          # @param next_page_key [nil, String]
+          # @param previous_page_key [nil, String]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/getWhatChanged/get
+          def get_what_changed_property_use_list(customer_id, date, next_page_key = nil, previous_page_key = nil)
+            request(Net::HTTP::Get, path_for("customer", customer_id, "propertyUse", "whatChanged"), {
+              "date" => date.strftime("%Y-%m-%d"),
+              "nextPageKey" => next_page_key,
+              "previousPageKey" => previous_page_key,
+            }, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+        end
+
+        # Test Environment
+        module Test
+        end
+      end
+
+      # Use Details
+      module UseDetails
+        # Live Environment
+        module Live
+          # Edit Use Details
+          #
+          # This web service updates a specific set of use details based on the
+          # information provided in the XML request. The update is performed by
+          # creating a revision history. It returns the unique identifier to the
+          # use details and a link to the corresponding web service to retrieve
+          # it. To specify the use of default values, just omit the "value" XML
+          # tag for that particular use detail information from the XML request
+          # or omit the entire reference to the particular use detail
+          # information from the XML request altogether.
+          #
+          # @param property_use_id [Integer]
+          # @param use_detail [PortfolioManager::Xml::AmountOfLaundryProcessedAnnuallyType, PortfolioManager::Xml::ClearHeightUnitsType, PortfolioManager::Xml::CoolingEquipmentRedundancyType, PortfolioManager::Xml::GrossFloorAreaType, PortfolioManager::Xml::HoursPerDayGuestsOnsiteType, PortfolioManager::Xml::ItEnergyConfigurationType, PortfolioManager::Xml::LengthOfAllOpenClosedRefrigerationUnitsType, PortfolioManager::Xml::LinksType, PortfolioManager::Xml::MonthsInUseType, PortfolioManager::Xml::NumberOfWeekdaysType, PortfolioManager::Xml::NumberOfWeeklyIceResurfacingType, PortfolioManager::Xml::OnsiteLaundryType, PortfolioManager::Xml::OptionalFloorAreaType, PortfolioManager::Xml::OwnedByType, PortfolioManager::Xml::PercentCooledType, PortfolioManager::Xml::PercentHeatedType, PortfolioManager::Xml::PercentOfficeCooledType, PortfolioManager::Xml::PercentOfficeHeatedType, PortfolioManager::Xml::PlantDesignFlowRateType, PortfolioManager::Xml::PoolSizeType, PortfolioManager::Xml::PoolType, PortfolioManager::Xml::ResidentPopulationType, PortfolioManager::Xml::UpsSystemRedundancyType, PortfolioManager::Xml::UseDecimalType, PortfolioManager::Xml::UseIntegerType, PortfolioManager::Xml::UseStringType, PortfolioManager::Xml::UseYesNoType]
+          # @param elename [nil, String]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/useDetails/post
+          def edit_use_details(property_use_id, use_detail, elename = nil)
+            request(Net::HTTP::Post, path_for("propertyUse", property_use_id, "useDetails"), {}, {}, use_detail, elename, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Edit Use Details - Correction
+          #
+          # This web service updates a specific set of use details based on the
+          # information provided in the XML request. The update is performed as
+          # a correction. It returns the unique identifier to the use details
+          # and a link to the corresponding web service to retrieve it. The
+          # corresponding property must already be shared with you. To specify
+          # the use of default values, just omit the "value" XML tag for that
+          # particular use detail information from the XML request or omit the
+          # entire reference to the particular use detail information from the
+          # XML request altogether.
+          #
+          # @param use_detail_id [Integer]
+          # @param use_detail [PortfolioManager::Xml::AmountOfLaundryProcessedAnnuallyType, PortfolioManager::Xml::ClearHeightUnitsType, PortfolioManager::Xml::CoolingEquipmentRedundancyType, PortfolioManager::Xml::GrossFloorAreaType, PortfolioManager::Xml::HoursPerDayGuestsOnsiteType, PortfolioManager::Xml::ItEnergyConfigurationType, PortfolioManager::Xml::LengthOfAllOpenClosedRefrigerationUnitsType, PortfolioManager::Xml::LinksType, PortfolioManager::Xml::MonthsInUseType, PortfolioManager::Xml::NumberOfWeekdaysType, PortfolioManager::Xml::NumberOfWeeklyIceResurfacingType, PortfolioManager::Xml::OnsiteLaundryType, PortfolioManager::Xml::OptionalFloorAreaType, PortfolioManager::Xml::OwnedByType, PortfolioManager::Xml::PercentCooledType, PortfolioManager::Xml::PercentHeatedType, PortfolioManager::Xml::PercentOfficeCooledType, PortfolioManager::Xml::PercentOfficeHeatedType, PortfolioManager::Xml::PlantDesignFlowRateType, PortfolioManager::Xml::PoolSizeType, PortfolioManager::Xml::PoolType, PortfolioManager::Xml::ResidentPopulationType, PortfolioManager::Xml::UpsSystemRedundancyType, PortfolioManager::Xml::UseDecimalType, PortfolioManager::Xml::UseIntegerType, PortfolioManager::Xml::UseStringType, PortfolioManager::Xml::UseYesNoType]
+          # @param elename [nil, String]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/useDetails/put
+          def edit_use_details_correction(use_detail_id, use_detail, elename = nil)
+            request(Net::HTTP::Put, path_for("useDetails", use_detail_id), {}, {}, use_detail, elename, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Get ID Hierarchy for Use Detail
+          #
+          # This web service returns the accountId, propertyId, and
+          # propertyUseId that corresponds to a specific use detail record. The
+          # accountId returned is the Property Data Administrator (PDA). The
+          # corresponding property must already be shared with you or you must
+          # have pending share access.
+          #
+          # @param use_detail_id [Integer]
+          # @return [PortfolioManager::Xml::HierarchyType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/useDetailsHierarchy/get
+          def get_id_hierarchy_for_use_detail(use_detail_id)
+            request(Net::HTTP::Get, path_for("idHierarchy", "useDetails", use_detail_id), {}, {}, nil, nil, PortfolioManager::Xml::HierarchyType, basic_auth: true)
+          end
+
+          # Get Use Details
+          #
+          # This web service retrieves specific use detail information for a
+          # given use detail. The corresponding property must already be shared
+          # with you.
+          #
+          # @param use_detail_id [Integer]
+          # @param klass [nil, Class]
+          # @return [PortfolioManager::Xml::AmountOfLaundryProcessedAnnuallyType, PortfolioManager::Xml::ClearHeightUnitsType, PortfolioManager::Xml::CoolingEquipmentRedundancyType, PortfolioManager::Xml::GrossFloorAreaType, PortfolioManager::Xml::HoursPerDayGuestsOnsiteType, PortfolioManager::Xml::ItEnergyConfigurationType, PortfolioManager::Xml::LengthOfAllOpenClosedRefrigerationUnitsType, PortfolioManager::Xml::LinksType, PortfolioManager::Xml::MonthsInUseType, PortfolioManager::Xml::NumberOfWeekdaysType, PortfolioManager::Xml::NumberOfWeeklyIceResurfacingType, PortfolioManager::Xml::OnsiteLaundryType, PortfolioManager::Xml::OptionalFloorAreaType, PortfolioManager::Xml::OwnedByType, PortfolioManager::Xml::PercentCooledType, PortfolioManager::Xml::PercentHeatedType, PortfolioManager::Xml::PercentOfficeCooledType, PortfolioManager::Xml::PercentOfficeHeatedType, PortfolioManager::Xml::PlantDesignFlowRateType, PortfolioManager::Xml::PoolSizeType, PortfolioManager::Xml::PoolType, PortfolioManager::Xml::ResidentPopulationType, PortfolioManager::Xml::UpsSystemRedundancyType, PortfolioManager::Xml::UseDecimalType, PortfolioManager::Xml::UseIntegerType, PortfolioManager::Xml::UseStringType, PortfolioManager::Xml::UseYesNoType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/useDetails/get
+          def get_use_details(use_detail_id, klass = nil)
+            request(Net::HTTP::Get, path_for("useDetails", use_detail_id), {}, {}, nil, nil, klass, basic_auth: true)
+          end
+
+          # Get Use Details Revision History
+          #
+          # This web service retrieves the use details revision history for a
+          # specific property use. The corresponding property must be already
+          # shared with you.
+          #
+          # @param property_use_id [Integer]
+          # @param current_as_of_start [Date]
+          # @param current_as_of_end [Date]
+          # @return [PortfolioManager::Xml::UseDetails, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/useDetailsRevisions/get
+          def get_use_details_revision_history(property_use_id, current_as_of_start, current_as_of_end)
+            request(Net::HTTP::Get, path_for("propertyUse", property_use_id, "useDetailsRevisions"), {
+              "currentAsOfStart" => current_as_of_start.strftime("%Y-%m-%d"),
+              "currentAsOfEnd" => current_as_of_end.strftime("%Y-%m-%d"),
+            }, {}, nil, nil, PortfolioManager::Xml::UseDetails, basic_auth: true)
+          end
+
+          # Get What Changed Property Use List (from use detail changes only)
+          #
+          # This web service returns a list of property uses that have had their
+          # use details changed since a user specified date. The list of
+          # property uses returned are account specific. Results are returned in
+          # increments of 1,000 per set. The returned list only shows property
+          # uses that you have permission to view. Actions that trigger a
+          # property use to be included in the returned list may have been
+          # performed by any user with permission to edit the property use
+          # details. A property use is displayed if it's corresponding use
+          # details are corrected, or updated with a new historical record.
+          #
+          # @param customer_id [Integer]
+          # @param date [Date]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/useDetailsGetWhatChanged/get
+          def get_what_changed_property_use_list_from_use_detail_changes_only(customer_id, date)
+            request(Net::HTTP::Get, path_for("customer", customer_id, "useDetails", "whatChanged"), {
+              "date" => date.strftime("%Y-%m-%d"),
+            }, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+        end
+
+        # Test Environment
+        module Test
+        end
+      end
+
+      # All Property Use Services
+      module All
+        # Live Environment
+        module Live
+          include PortfolioManager::Services::PropertyUse::PropertyUse::Live
+          include PortfolioManager::Services::PropertyUse::UseDetails::Live
+        end
+
+        # Test Environment
+        module Test
+          include PortfolioManager::Services::PropertyUse::PropertyUse::Test
+          include PortfolioManager::Services::PropertyUse::UseDetails::Test
+        end
+      end
+    end
+  end
+end

data/lib/portfolio_manager/services/reporting.rb

@@ -0,0 +1,208 @@
+require "net/http"
+
+module PortfolioManager
+  module Services
+    # Reporting Services
+    #
+    # The Reporting Services allows you to retrieve metrics for your properties.
+    #
+    # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting
+    module Reporting
+      # Reporting
+      module Reporting
+        # Live Environment
+        module Live
+          # Get Design Metrics
+          #
+          # This web service returns a list of metric values for a specific
+          # property design based on a specified measurement system. If the
+          # property contains operational data then an additional set of metric
+          # values based on the property's current period ending date is also
+          # returned. The property must already be shared with you. A full list
+          # of the reporting metrics that are available through this service and
+          # related web services can be found {https://downloads.energystar.gov/bi/portfolio-manager/Custom_Reporting_Metric_Inventory_en_US.xlsx here}.
+          # The list includes the metric name, the appropriate web service call
+          # for the metric, and a glossary link. It can be sorted and filtered
+          # for ease of finding the metrics that you need.
+          #
+          # @note Metrics that are readily available through other web services,
+          #   such as {PortfolioManager::Services::Property::Design::Live#get_design GET /property/(propertyId)/design}
+          #   are not included in the reporting web services, since they are
+          #   already accessible elsewhere.
+          #
+          # @param property_id [Integer]
+          # @param measurement_system [nil, "EPA", "METRIC"]
+          # @return [PortfolioManager::Xml::PropertyMetricsType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/designMetrics/get
+          def get_design_metrics(property_id, measurement_system = nil)
+            request(Net::HTTP::Get, path_for("property", property_id, "design", "metrics"), {
+              "measurementSystem" => measurement_system,
+            }, {}, nil, nil, PortfolioManager::Xml::PropertyMetricsType, basic_auth: true)
+          end
+
+          # Get Property Metrics
+          #
+          # This web service returns a list of metric values for a specific
+          # property and period ending date based on the specified set of
+          # metrics and measurement system. The property must already be shared
+          # with you. A full list of the reporting metrics that are available
+          # through this service and related web services can be found {https://downloads.energystar.gov/bi/portfolio-manager/Custom_Reporting_Metric_Inventory_en_US.xlsx here}.
+          # The list includes the metric name, the appropriate web service call
+          # for the metric, and a glossary link. It can be sorted and filtered
+          # for ease of finding the metrics that you need.
+          #
+          # @note Metrics that are readily available through other web services,
+          #   such as {PortfolioManager::Services::Property::Property::Live#get_property GET /property/(propertyId)}
+          #   and {PortfolioManager::Services::PropertyUse::PropertyUse::Live#get_property_use GET /propertyUse/(propertyUseId)}
+          #   are not included in the reporting web services, since they are
+          #   already accessible elsewhere.
+          #
+          # @param property_id [Integer]
+          # @param year [Integer]
+          # @param month [Integer]
+          # @param measurement_system [nil, "EPA", "METRIC"]
+          # @param metrics [Array<#to_s>]
+          # @return [PortfolioManager::Xml::PropertyMetricsType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/propertyMetrics/get
+          def get_property_metrics(property_id, year, month, measurement_system = nil, metrics = [])
+            request(Net::HTTP::Get, path_for("property", property_id, "metrics"), {
+              "year" => year,
+              "month" => month,
+              "measurementSystem" => measurement_system,
+            }, {
+              "PM-Metrics" => metrics.collect(&:to_s).join(","),
+            }, nil, nil, PortfolioManager::Xml::PropertyMetricsType, basic_auth: true)
+          end
+
+          # Get Property Monthly Metrics
+          #
+          # This web service returns a list of metric values for a specific
+          # property and period ending date based on the specified set of
+          # metrics and measurement system. Each monthly metric will return 12
+          # values (a value for each month). The months returned are all months
+          # captured within the specified annual period ending date. The metrics
+          # will reflect monthly totals of meters that you have access to.
+          #
+          # @param property_id [Integer]
+          # @param year [Integer]
+          # @param month [Integer]
+          # @param measurement_system [nil, "EPA", "METRIC"]
+          # @param metrics [Array<#to_s>]
+          # @return [PortfolioManager::Xml::PropertyMetricsType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/propertyMetricsMonthly/get
+          def get_property_monthly_metrics(property_id, year, month, measurement_system = nil, metrics = [])
+            request(Net::HTTP::Get, path_for("property", property_id, "metrics", "monthly"), {
+              "year" => year,
+              "month" => month,
+              "measurementSystem" => measurement_system,
+            }, {
+              "PM-Metrics" => metrics.collect(&:to_s).join(","),
+            }, nil, nil, PortfolioManager::Xml::PropertyMetricsType, basic_auth: true)
+          end
+
+          # Get Property Use Metrics
+          #
+          # This web service returns a list of time-weighted use detail values
+          # for a specific property, period ending date, and measurement system.
+          # The property must already be shared with you. A full list of the
+          # reporting metrics that are available through this service and
+          # related web services can be found {https://downloads.energystar.gov/bi/portfolio-manager/Custom_Reporting_Metric_Inventory_en_US.xlsx here}.
+          # The list includes the metric name, the appropriate web service call
+          # for the metric, and a glossary link. It can be sorted and filtered
+          # for ease of finding the metrics that you need.
+          #
+          # @param property_id [Integer]
+          # @param year [Integer]
+          # @param month [Integer]
+          # @param measurement_system [nil, "EPA", "METRIC"]
+          # @return [PortfolioManager::Xml::PropertyMetricsType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/useDetailsMetrics/get
+          def get_property_use_metrics(property_id, year, month, measurement_system = nil)
+            request(Net::HTTP::Get, path_for("property", property_id, "useDetails", "metrics"), {
+              "year" => year,
+              "month" => month,
+              "measurementSystem" => measurement_system,
+            }, {}, nil, nil, PortfolioManager::Xml::PropertyMetricsType, basic_auth: true)
+          end
+
+          # Get Reasons for No Energy Score
+          #
+          # This web service returns a list of reasons that explain why the
+          # specific property cannot receive an ENERGY STAR score for a certain
+          # period ending date. If both the year and month are not provided then
+          # the property's current energy period ending date is used. Please
+          # refer to this {https://downloads.energystar.gov/bi/portfolio-manager/Alerts_Public_Reference_en_US.xlsx Alert Inventory}
+          # for a list of possible reasons you might see in the response. Refer
+          # specifically to the alerts that are denoted "yes" in the N/A
+          # Explanations column; these are the alerts that apply when a metric,
+          # like the ENERGY STAR score, cannot be computed.
+          #
+          # @param property_id [Integer]
+          # @param year [Integer]
+          # @param month [Integer]
+          # @return [PortfolioManager::Xml::AlertsType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/reasonsForNoScore/get
+          def get_reasons_for_no_energy_score(property_id, year, month)
+            request(Net::HTTP::Get, path_for("property", property_id, "reasonsForNoScore"), {
+              "year" => year,
+              "month" => month,
+            }, {}, nil, nil, PortfolioManager::Xml::AlertsType, basic_auth: true)
+          end
+
+          # Get Reasons for No Water Score
+          #
+          # This web service returns a list of reasons that explain why the
+          # specific property cannot receive an ENERGY STAR score for a certain
+          # period ending date. If both the year and month are not provided then
+          # the property's current water period ending date is used. Please
+          # refer to this {https://downloads.energystar.gov/bi/portfolio-manager/Alerts_Public_Reference_en_US.xlsx Alert Inventory}
+          # for a list of possible reasons you might see in the response. Refer
+          # specifically to the alerts that are denoted "yes" in the N/A
+          # Explanations column; these are the alerts that apply when a metric,
+          # like the ENERGY STAR score, cannot be computed.
+          #
+          # @param property_id [Integer]
+          # @param year [Integer]
+          # @param month [Integer]
+          # @return [PortfolioManager::Xml::AlertsType, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/reasonsForNoWaterScore/get
+          def get_reasons_for_no_water_score(property_id, year, month)
+            request(Net::HTTP::Get, path_for("property", property_id, "reasonsForNoWaterScore"), {
+              "year" => year,
+              "month" => month,
+            }, {}, nil, nil, PortfolioManager::Xml::AlertsType, basic_auth: true)
+          end
+        end
+
+        # Test Environment
+        module Test
+        end
+      end
+
+      # All Reporting Services
+      module All
+        # Live Environment
+        module Live
+          include PortfolioManager::Services::Reporting::Reporting::Live
+        end
+
+        # Test Environment
+        module Test
+          include PortfolioManager::Services::Reporting::Reporting::Test
+        end
+      end
+    end
+  end
+end

data/lib/portfolio_manager/services/target_finder.rb

@@ -0,0 +1,76 @@
+require "net/http"
+
+module PortfolioManager
+  module Services
+    # Target Finder Services
+    #
+    # Target Finder Services allows you to retrieve the estimated annual energy
+    # consumption associated with specific property design characteristics, and
+    # an energy performance goal expressed as either an ENERGY STAR score or %
+    # Better than Median. Conversely, you may also retrieve the ENERGY STAR
+    # score and % Better than Median associated with the estimated annual energy
+    # consumption of a specific property design. These metrics allow you to
+    # estimate how much energy your property would need to consume annually to
+    # reach your design energy goal, or conversely, determine the ENERGY STAR
+    # score that would be associated with your design estimated energy
+    # consumption. Target Finder Services does require user authentication but
+    # the property design information that you submit will not be saved for
+    # later reference. Your results can be returned in the set of units that you
+    # specify.
+    #
+    # @see https://portfoliomanager.energystar.gov/webservices/home/api/targetFinder
+    module TargetFinder
+      # Target Finder
+      module TargetFinder
+        # Live Environment
+        module Live
+          # Target Finder
+          #
+          # This web service allows you to retrieve the estimated annual energy
+          # consumption associated with specific property design
+          # characteristics, and an energy performance goal expressed as either
+          # an ENERGY STAR score or % Better than Median. Conversely, you may
+          # also retrieve the ENERGY STAR score and % Better than Median
+          # associated with the estimated annual energy consumption of a
+          # specific property design. These metrics allow you to estimate how
+          # much energy your property would need to consume annually to reach
+          # your design energy goal, or conversely, determine the ENERGY STAR
+          # score that would be associated with your design estimated energy
+          # consumption. Target Finder Services does require user authentication
+          # but the property design information that you submit will not be
+          # saved for later reference. Your results can be returned in the set
+          # of units that you specify.
+          #
+          # @param target_finder [PortfolioManager::Xml::UnAuthDesignType]
+          # @param measurement_system ["EPA", "METRIC"]
+          # @return [PortfolioManager::Xml::PropertyMetricsList, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/targetFinder/targetFinder/post
+          def target_finder(target_finder, measurement_system = "EPA")
+            request(Net::HTTP::Get, path_for("targetFinder"), {
+              "measurementSystem" => measurement_system,
+            }, {}, target_finder, "targetFinder", PortfolioManager::Xml::PropertyMetricsList, basic_auth: true)
+          end
+        end
+
+        # Test Environment
+        module Test
+        end
+      end
+
+      # All Target Finder Services
+      module All
+        # Live Environment
+        module Live
+          include PortfolioManager::Services::TargetFinder::TargetFinder::Live
+        end
+
+        # Test Environment
+        module Test
+          include PortfolioManager::Services::TargetFinder::TargetFinder::Test
+        end
+      end
+    end
+  end
+end

data/lib/portfolio_manager/services.rb

@@ -0,0 +1,21 @@
+module PortfolioManager
+  # Web Services
+  #
+  # For your convenience, EPA has organized web services into the following
+  # major categories. Click on each category to view the list of web services
+  # and their corresponding XML schemas. If you want to download all the
+  # schemas, please click {https://portfoliomanager.energystar.gov/schema/18.0/portfoliomanager-schemas-18.0.zip here}.
+  #
+  # @see https://portfoliomanager.energystar.gov/webservices/home/api
+  module Services
+    autoload :All,          "portfolio_manager/services/all"
+    autoload :BasicAccount, "portfolio_manager/services/basic_account"
+    autoload :Building,     "portfolio_manager/services/building"
+    autoload :Connection,   "portfolio_manager/services/connection"
+    autoload :Meter,        "portfolio_manager/services/meter"
+    autoload :Property,     "portfolio_manager/services/property"
+    autoload :PropertyUse,  "portfolio_manager/services/property_use"
+    autoload :Reporting,    "portfolio_manager/services/reporting"
+    autoload :TargetFinder, "portfolio_manager/services/target_finder"
+  end
+end

data/lib/portfolio_manager/version.rb

@@ -0,0 +1,3 @@
+module PortfolioManager
+  VERSION = "0.0.1"
+end