portfoliomanager-rb 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e310075331d242ff44cca8e3bca7bf00bc0955bfbfe1b6d9937e012bc2885c6f
-  data.tar.gz: 24be387d4ba38f8b1f78ce6ceaada3cc47252501bfce7ca57b43dc5326fd0a2c
+  metadata.gz: 96b9ef75d20a06c5b4b2f044194edd2f4acdf7fdb2da8c722bbc1f1d44813141
+  data.tar.gz: 2fa42c27c5070a90c39c44124dca00efa75bcfb8c4a61685a80b072350f641a7
 SHA512:
-  metadata.gz: 27d006e5343af0b22823745a1885fc32437505c8826da51d49618cd1d8a10af482cb82e5f6db636ebe0b6253f6aa2ab1dada0ead99e2dd858e15315d0f7d49a7
-  data.tar.gz: ce61c5d502631455af3ad2aef72107fc2d52a36d355499a0d1da24f3e93b4b5b1465b5852c05d18bb9bac11e13c9672312acd17bdbf7a5210883a87cd102c308
+  metadata.gz: 4f16514cf4ed04d006e73ddc249ac9cbaa213b9eaf68679aa6a687a4f50400459c009efe43f8d483bbe5eb44c5aa0b33aca343f3c924f583bb8c405f1b2e2dd9
+  data.tar.gz: 0ca1376fb8a2cefc90ed1057d5f22ac1de50d887094344e8b561191dc1c53972ad7346efa978254cf47fa343d7eb93251a1665d35f242e507de84462015d8857

data/CHANGELOG.md

@@ -8,25 +8,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ## [0.0.1] - 2022-02-23
+
 ### Added
 - Initial commit.
 
 ## [0.0.2] - 2023-11-17
+
 ### Changed
 - Update from v18 to v21.
 
 ## [0.0.3] - 2024-05-13
+
+### Changed
 - Update from v21 to v22.
 
 ## [0.0.4] - 2024-05-14
+
+### Changed
 - Fix return value classes for `PortfolioManager::Services::Connection::ConnectionShare::Live#accept_reject_pending_connection_requests`, `PortfolioManager::Services::Connection::ConnectionShare::Live#accept_reject_pending_meter_share_requests`, and `PortfolioManager::Services::Connection::ConnectionShare::Live#accept_reject_pending_property_share_requests` methods.
 
 ## [0.0.5] - 2024-05-15
+
+### Changed
 - Force encoding of HTTP response body to be UTF-8.
 
 ## [0.0.6] - 2024-05-16
+
+### Added
 - Add support for proxy servers.
 
+## [0.0.7] - 2024-05-31
+
+### Added
+- Add "Custom Metrics" web services to "Property Services" (added in v22).
+
+### Changed
+- Fix error handling in `PortfolioManager::Client::Base#request`.
+- Fix return value classes for `PortfolioManager::Xml::ResponseType`.
+
 [Unreleased]: https://github.com/pnnl/portfoliomanager-rb/compare/v0.0.1...HEAD
 [0.0.1]: https://github.com/pnnl/portfoliomanager-rb/releases/tag/v0.0.1
 [0.0.2]: https://github.com/pnnl/portfoliomanager-rb/releases/tag/v0.0.2
@@ -34,3 +53,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.0.4]: https://github.com/pnnl/portfoliomanager-rb/releases/tag/v0.0.4
 [0.0.5]: https://github.com/pnnl/portfoliomanager-rb/releases/tag/v0.0.5
 [0.0.6]: https://github.com/pnnl/portfoliomanager-rb/releases/tag/v0.0.6
+[0.0.7]: https://github.com/pnnl/portfoliomanager-rb/releases/tag/v0.0.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    portfoliomanager-rb (0.0.6)
+    portfoliomanager-rb (0.0.7)
       logger-application (~> 0.0.2)
       soap4r-ng (~> 2.0.4)
 

data/lib/portfolio_manager/client.rb

@@ -85,6 +85,7 @@ module PortfolioManager
       # @return [Object]
       # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
       # @raise [PortfolioManager::HTTPResponseError]
+      # @see https://portfoliomanager.energystar.gov/webservices/home/errors
       def request(verb = Net::HTTP::Get, path = "/", params = {}, initheader = {}, obj = nil, elename = nil, klass = nil, **options)
         uri = url_for(path, params)
 
@@ -138,7 +139,7 @@ module PortfolioManager
           }.join("\n")) if @debug
 
           if response_body_utf8.start_with?("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>")
-            PortfolioManager::Mapper.instance.xml2obj(response_body_utf8, klass)
+            PortfolioManager::Mapper.instance.xml2obj(response_body_utf8, response.code.start_with?("2") ? klass : PortfolioManager::Xml::ResponseType)
           else
             raise PortfolioManager::HTTPResponseError.new(response)
           end

data/lib/portfolio_manager/services/basic_account.rb

@@ -85,7 +85,7 @@ module PortfolioManager
           # This web service retrieves your account information that includes
           # your username, password, and contact information.
           #
-          # @return [PortfolioManager::Xml::AccountType]
+          # @return [PortfolioManager::Xml::AccountType, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/account/account/get
@@ -100,7 +100,7 @@ module PortfolioManager
           # billboard display, see the "Account" and "Property" documentation
           # sections.
           #
-          # @return [PortfolioManager::Xml::BillboardMetricsType]
+          # @return [PortfolioManager::Xml::BillboardMetricsType, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/account/billboardMetricList/get
@@ -160,7 +160,7 @@ module PortfolioManager
           # identifier to the newly created account and a link to the
           # corresponding web service to retrieve it.
           #
-          # @param account [PortfolioManager::Xml::AccountType, PortfolioManager::Xml::ResponseType]
+          # @param account [PortfolioManager::Xml::AccountType]
           # @return [PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/test/api/account/account/post
@@ -181,7 +181,7 @@ module PortfolioManager
           # Note that there is no validation performed on the specified display
           # order.
           #
-          # @param custom_field [PortfolioManager::Xml::CustomField, PortfolioManager::Xml::ResponseType]
+          # @param custom_field [PortfolioManager::Xml::CustomField]
           # @return [PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
@@ -268,7 +268,7 @@ module PortfolioManager
           # data exchange service offerings such as terms and conditions,
           # supported fuel types, etc.
           #
-          # @return [PortfolioManager::Xml::DataExchangeSettings]
+          # @return [PortfolioManager::Xml::DataExchangeSettings, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/account/settings/get

data/lib/portfolio_manager/services/home_energy_yardstick.rb

@@ -38,7 +38,7 @@ module PortfolioManager
           # - Wood
           #
           # @param hey [PortfolioManager::Xml::HeyType]
-          # @return [PortfolioManager::Xml::PropertyMetricsType]
+          # @return [PortfolioManager::Xml::PropertyMetricsType, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/hey/hey/post

data/lib/portfolio_manager/services/property.rb

@@ -169,6 +169,131 @@ module PortfolioManager
         end
       end
 
+      # Custom Metrics
+      module CustomMetrics
+        # Live Environment
+        module Live
+          # Get Custom Metrics
+          #
+          # This web service returns a list of custom metrics for a specific
+          # property. A maximum of 3 custom metrics per property can be defined.
+          # 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/property/customMetrics/get
+          def get_custom_metrics(property_id)
+            request(Net::HTTP::Get, path_for("property", property_id, "customMetrics"), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Get Custom Metric
+          #
+          # This web service returns information for a specific custom metric
+          # for a given property. The property must already be shared with you.
+          #
+          # @param property_id [Integer]
+          # @param custom_metric_slot [Integer]
+          # @return [PortfolioManager::Xml::CustomMetric, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/property/customMetric/get
+          def get_custom_metric(property_id, custom_metric_slot)
+            request(Net::HTTP::Get, path_for("property", property_id, "customMetrics", custom_metric_slot), {}, {}, nil, nil, PortfolioManager::Xml::CustomMetric, basic_auth: true)
+          end
+
+          # Add Custom Metric
+          #
+          # This web service adds a new custom metric based on the information
+          # provided in the XML request for a specified property. The property
+          # must already be shared with you. A maximum of 3 custom metrics per
+          # property can be defined.
+          #
+          # @param property_id [Integer]
+          # @param custom_metric_slot [Integer]
+          # @param custom_metric [PortfolioManager::Xml::CustomMetric]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/property/customMetric/post
+          def add_custom_metric(property_id, custom_metric_slot, custom_metric)
+            request(Net::HTTP::Post, path_for("property", property_id, "customMetrics", custom_metric_slot), {}, {}, custom_metric, "customMetric", PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Edit Custom Metric
+          #
+          # This web service updates a specific custom metric based on the
+          # information provided in the XML request for a given property. The
+          # property must already be shared with you.
+          #
+          # @param property_id [Integer]
+          # @param custom_metric_slot [Integer]
+          # @param custom_metric [PortfolioManager::Xml::CustomMetric]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/property/customMetric/put
+          def edit_custom_metric(property_id, custom_metric_slot, custom_metric)
+            request(Net::HTTP::Put, path_for("property", property_id, "customMetrics", custom_metric_slot), {}, {}, custom_metric, "customMetric", PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Delete Custom Metric
+          #
+          # This web service deletes a specific custom metric for a given
+          # property. The property must already be shared with you.
+          #
+          # @param property_id [Integer]
+          # @param custom_metric_slot [Integer]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/property/customMetric/delete
+          def delete_custom_metric(property_id, custom_metric_slot)
+            request(Net::HTTP::Delete, path_for("property", property_id, "customMetrics", custom_metric_slot), {}, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Get Available Property Use Details (for Custom Metrics)
+          #
+          # This web service returns a list of all the property use details of a
+          # given property that can be used to define in a custom metric (the
+          # denominator of a custom metric). The property must already be shared
+          # with you.
+          #
+          # @param property_id [Integer]
+          # @return [PortfolioManager::Xml::DetailsTypes, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/property/availablePropertyUseDetails/get
+          def get_available_property_use_details_for_custom_metrics(property_id)
+            request(Net::HTTP::Get, path_for("property", property_id, "customMetrics", "availablePropertyUseDetails"), {}, {}, nil, nil, PortfolioManager::Xml::DetailsTypes, basic_auth: true)
+          end
+
+          # Get Available Metrics List
+          #
+          # This web service returns a list of all available metrics that can be
+          # used to define in a custom metric (the numerator of a custom
+          # metric).
+          #
+          # @param group_ids [nil, Array<Integer>]
+          # @param available_to_custom_metrics [nil, Boolean]
+          # @return [PortfolioManager::Xml::ReportMetrics, PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/property/availableMetricsList/get
+          def get_available_metrics_list(group_ids = nil, available_to_custom_metrics = nil)
+            request(Net::HTTP::Get, path_for("reports", "metrics"), {
+              "groupIds" => (group_ids.nil? || group_ids.empty?) ? nil : group_ids.collect(&:to_s).join(","),
+              "availableToCustomMetrics" => available_to_custom_metrics,
+            }, {}, nil, nil, PortfolioManager::Xml::ReportMetrics, basic_auth: true)
+          end
+        end
+
+        # Test Environment
+        module Test
+        end
+      end
+
       # Design
       module Design
         # Live Environment
@@ -929,6 +1054,7 @@ module PortfolioManager
         module Live
           include PortfolioManager::Services::Property::Property::Live
           include PortfolioManager::Services::Property::Design::Live
+          include PortfolioManager::Services::Property::CustomMetrics::Live
           include PortfolioManager::Services::Property::ElectricDistributionUtility::Live
           include PortfolioManager::Services::Property::PowerGenerationPlant::Live
           include PortfolioManager::Services::Property::InternationalWeatherStation::Live
@@ -941,6 +1067,7 @@ module PortfolioManager
         module Test
           include PortfolioManager::Services::Property::Property::Test
           include PortfolioManager::Services::Property::Design::Test
+          include PortfolioManager::Services::Property::CustomMetrics::Test
           include PortfolioManager::Services::Property::ElectricDistributionUtility::Test
           include PortfolioManager::Services::Property::PowerGenerationPlant::Test
           include PortfolioManager::Services::Property::InternationalWeatherStation::Test

data/lib/portfolio_manager/services/property_use.rb

@@ -26,7 +26,7 @@ module PortfolioManager
           # 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::EvChargingStationType, PortfolioManager::Xml::FinancialOfficeType, PortfolioManager::Xml::FoodSalesType, PortfolioManager::Xml::HospitalType, PortfolioManager::Xml::HotelType, PortfolioManager::Xml::IceCurlingRinkType, PortfolioManager::Xml::IndoorArenaType, PortfolioManager::Xml::K12SchoolType, PortfolioManager::Xml::MailingCenterPostOfficeType, PortfolioManager::Xml::MedicalOfficeType, PortfolioManager::Xml::MultifamilyHousingType, PortfolioManager::Xml::NonRefrigeratedWarehouseType, PortfolioManager::Xml::OfficeType, PortfolioManager::Xml::OtherStadiumType, PortfolioManager::Xml::OtherType, 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::VehicleDealershipType, PortfolioManager::Xml::WastewaterTreatmentPlantType, PortfolioManager::Xml::WholesaleClubSupercenterType, PortfolioManager::Xml::WorshipFacilityType]
+          # @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::EvChargingStationType, PortfolioManager::Xml::FinancialOfficeType, PortfolioManager::Xml::FoodSalesType, PortfolioManager::Xml::HospitalType, PortfolioManager::Xml::HotelType, PortfolioManager::Xml::IceCurlingRinkType, PortfolioManager::Xml::IndoorArenaType, PortfolioManager::Xml::K12SchoolType, PortfolioManager::Xml::LibraryType, PortfolioManager::Xml::MailingCenterPostOfficeType, PortfolioManager::Xml::MedicalOfficeType, PortfolioManager::Xml::MultifamilyHousingType, PortfolioManager::Xml::MuseumType, PortfolioManager::Xml::NonRefrigeratedWarehouseType, PortfolioManager::Xml::OfficeType, PortfolioManager::Xml::OtherStadiumType, PortfolioManager::Xml::OtherType, 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::VehicleDealershipType, PortfolioManager::Xml::WastewaterTreatmentPlantType, PortfolioManager::Xml::WholesaleClubSupercenterType, PortfolioManager::Xml::WorshipFacilityType]
           # @param elename [nil, String]
           # @return [PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
@@ -97,7 +97,7 @@ module PortfolioManager
           #
           # @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::EvChargingStationType, PortfolioManager::Xml::FinancialOfficeType, PortfolioManager::Xml::FoodSalesType, PortfolioManager::Xml::HospitalType, PortfolioManager::Xml::HotelType, PortfolioManager::Xml::IceCurlingRinkType, PortfolioManager::Xml::IndoorArenaType, PortfolioManager::Xml::K12SchoolType, PortfolioManager::Xml::MailingCenterPostOfficeType, PortfolioManager::Xml::MedicalOfficeType, PortfolioManager::Xml::MultifamilyHousingType, PortfolioManager::Xml::NonRefrigeratedWarehouseType, PortfolioManager::Xml::OfficeType, PortfolioManager::Xml::OtherStadiumType, PortfolioManager::Xml::OtherType, 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::VehicleDealershipType, PortfolioManager::Xml::WastewaterTreatmentPlantType, PortfolioManager::Xml::WholesaleClubSupercenterType, PortfolioManager::Xml::WorshipFacilityType, PortfolioManager::Xml::ResponseType]
+          # @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::EvChargingStationType, PortfolioManager::Xml::FinancialOfficeType, PortfolioManager::Xml::FoodSalesType, PortfolioManager::Xml::HospitalType, PortfolioManager::Xml::HotelType, PortfolioManager::Xml::IceCurlingRinkType, PortfolioManager::Xml::IndoorArenaType, PortfolioManager::Xml::K12SchoolType, PortfolioManager::Xml::LibraryType, PortfolioManager::Xml::MailingCenterPostOfficeType, PortfolioManager::Xml::MedicalOfficeType, PortfolioManager::Xml::MultifamilyHousingType, PortfolioManager::Xml::MuseumType, PortfolioManager::Xml::NonRefrigeratedWarehouseType, PortfolioManager::Xml::OfficeType, PortfolioManager::Xml::OtherStadiumType, PortfolioManager::Xml::OtherType, 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::VehicleDealershipType, 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
@@ -302,7 +302,7 @@ module PortfolioManager
           # you.
           #
           # @param property_id [Integer]
-          # @return [PortfolioManager::Xml::CustomUseType]
+          # @return [PortfolioManager::Xml::CustomUseType, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUse/get
@@ -319,7 +319,7 @@ module PortfolioManager
           # @param property_id [Integer]
           # @param current_as_of_start [Date]
           # @param current_as_of_end [Date]
-          # @return [PortfolioManager::Xml::UseDetails]
+          # @return [PortfolioManager::Xml::UseDetails, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUseDetailsRevisions/get
@@ -360,7 +360,7 @@ module PortfolioManager
           # shared with you.
           #
           # @param details_id [Integer]
-          # @return [PortfolioManager::Xml::CustomUseDetailsType]
+          # @return [PortfolioManager::Xml::CustomUseDetailsType, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUseDetails/get

data/lib/portfolio_manager/services/reporting.rb

@@ -18,13 +18,15 @@ module PortfolioManager
           # used in a report template.
           #
           # @param group_ids [nil, Array<Integer>]
-          # @return [PortfolioManager::Xml::ReportMetrics]
+          # @param available_to_custom_metrics [nil, Boolean]
+          # @return [PortfolioManager::Xml::ReportMetrics, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/availableMetricsList/get
-          def get_available_metrics_list(group_ids = nil)
+          def get_available_metrics_list(group_ids = nil, available_to_custom_metrics = nil)
             request(Net::HTTP::Get, path_for("reports", "metrics"), {
               "groupIds" => (group_ids.nil? || group_ids.empty?) ? nil : group_ids.collect(&:to_s).join(","),
+              "availableToCustomMetrics" => available_to_custom_metrics,
             }, {}, nil, nil, PortfolioManager::Xml::ReportMetrics, basic_auth: true)
           end
 
@@ -71,7 +73,7 @@ module PortfolioManager
           # template must be owned by you.
           #
           # @param template_id [Integer]
-          # @return [PortfolioManager::Xml::ReportTemplateType]
+          # @return [PortfolioManager::Xml::ReportTemplateType, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/template/get
@@ -163,7 +165,7 @@ module PortfolioManager
           # template for a specific report. The report must be owned by you.
           #
           # @param report_id [Integer]
-          # @return [PortfolioManager::Xml::Report]
+          # @return [PortfolioManager::Xml::Report, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/report/get
@@ -205,12 +207,12 @@ module PortfolioManager
           #
           # @param report_id [Integer]
           # @param type ["EXCEL", "XML"]
-          # @return [PortfolioManager::Xml::Report]
+          # @return [PortfolioManager::Xml::Report, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/reportResults/get
           def get_report_results(report_id, type = "XML")
-            request(Net::HTTP::Get, path_for("reports", report_id), {
+            request(Net::HTTP::Get, path_for("reports", report_id, "download"), {
               "type" => type,
             }, {}, nil, nil, PortfolioManager::Xml::Report, basic_auth: true)
           end
@@ -257,7 +259,7 @@ module PortfolioManager
           #   available for download.
           #
           # @param report_id [Integer]
-          # @return [PortfolioManager::Xml::ReportStatusDef]
+          # @return [PortfolioManager::Xml::ReportStatusDef, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/reportStatus/get
@@ -298,7 +300,7 @@ module PortfolioManager
           #
           # @param customer_id [Integer]
           # @param data_request_id [Integer]
-          # @return [PortfolioManager::Xml::DataRequest]
+          # @return [PortfolioManager::Xml::DataRequest, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/customerDataRequest/get
@@ -358,7 +360,7 @@ module PortfolioManager
           #
           # @param customer_id [Integer]
           # @param data_response_id [Integer]
-          # @return [PortfolioManager::Xml::DataResponse]
+          # @return [PortfolioManager::Xml::DataResponse, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/dataResponse/get
@@ -418,7 +420,7 @@ module PortfolioManager
           # @param customer_id [Integer]
           # @param data_response_id [Integer]
           # @param type ["EXCEL", "XML"]
-          # @return [PortfolioManager::Xml::ResponseStatus]
+          # @return [PortfolioManager::Xml::ResponseStatus, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/downloadErrorsDataResponse/get
@@ -512,7 +514,7 @@ module PortfolioManager
           #
           # @param customer_id [Integer]
           # @param data_response_id [Integer]
-          # @return [PortfolioManager::Xml::ResponseStatus]
+          # @return [PortfolioManager::Xml::ResponseStatus, PortfolioManager::Xml::ResponseType]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/reporting/statusDataResponse/get

data/lib/portfolio_manager/version.rb

@@ -1,3 +1,3 @@
 module PortfolioManager
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portfoliomanager-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Mark Borkum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger-application