portfoliomanager-rb 0.0.1 → 0.0.3

data/lib/portfolio_manager/services/all.rb

@@ -7,6 +7,7 @@ module PortfolioManager
         include PortfolioManager::Services::BasicAccount::All::Live
         include PortfolioManager::Services::Building::All::Live
         include PortfolioManager::Services::Connection::All::Live
+        include PortfolioManager::Services::HomeEnergyYardstick::All::Live
         include PortfolioManager::Services::Meter::All::Live
         include PortfolioManager::Services::Property::All::Live
         include PortfolioManager::Services::PropertyUse::All::Live
@@ -14,11 +15,12 @@ module PortfolioManager
         include PortfolioManager::Services::TargetFinder::All::Live
       end
 
-      # Test Environment  
+      # Test Environment
       module Test
         include PortfolioManager::Services::BasicAccount::All::Test
         include PortfolioManager::Services::Building::All::Test
         include PortfolioManager::Services::Connection::All::Test
+        include PortfolioManager::Services::HomeEnergyYardstick::All::Test
         include PortfolioManager::Services::Meter::All::Test
         include PortfolioManager::Services::Property::All::Test
         include PortfolioManager::Services::PropertyUse::All::Test

data/lib/portfolio_manager/services/home_energy_yardstick.rb

@@ -0,0 +1,69 @@
+require "net/http"
+
+module PortfolioManager
+  module Services
+    # Home Energy Yardstick Services
+    #
+    # Home Energy Yardstick Services allows you to receive a simple assessment
+    # of your home's annual energy use compared to similar homes. By providing
+    # some information about your home, you can get your home's Home Energy
+    # Yardstick score (on a scale of 1 to 100), insights into how much of your
+    # home's energy use is related to heating and cooling versus other everyday
+    # uses like appliances, lighting, and hot water. You will also be able to
+    # receive an estimate of your home's annual carbon emissions. Home Energy
+    # Yardstick Services do require user authenication and the home information
+    # that you submit will not be saved for later reference.
+    #
+    # @see https://portfoliomanager.energystar.gov/webservices/home/api/hey
+    module HomeEnergyYardstick
+      # Home Energy Yardstick
+      module HomeEnergyYardstick
+        # Live Environment
+        module Live
+          # Home Energy Yardstick
+          #
+          # This web service returns a list of performance-based home assessment
+          # metrics for a specified home's design characteristics and energy
+          # use. Home Energy Yardstick Service does require user authentication
+          # but the home design information that you submit will not be saved
+          # for later reference.
+          #
+          # The following meter types are only allowed:
+          # - Coal Bituminous
+          # - Electric
+          # - Fuel Oil No 2
+          # - Kerosene
+          # - Natural Gas
+          # - Propane
+          # - Wood
+          #
+          # @param hey [PortfolioManager::Xml::HeyType]
+          # @return [PortfolioManager::Xml::PropertyMetricsType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/hey/hey/post
+          def home_energy_yardstick(hey)
+            request(Net::HTTP::Post, path_for("hey"), {}, {}, hey, "hey", PortfolioManager::Xml::PropertyMetricsType, basic_auth: true)
+          end
+        end
+
+        # Test Environment
+        module Test
+        end
+      end
+
+      # Home Energy Yardstick Services
+      module All
+        # Live Environment
+        module Live
+          include PortfolioManager::Services::HomeEnergyYardstick::HomeEnergyYardstick::Live
+        end
+
+        # Test Environment
+        module Test
+          include PortfolioManager::Services::HomeEnergyYardstick::HomeEnergyYardstick::Test
+        end
+      end
+    end
+  end
+end

data/lib/portfolio_manager/services/property.rb

@@ -143,6 +143,29 @@ module PortfolioManager
 
         # Test Environment
         module Test
+          # Add Sample Properties
+          #
+          # This web service creates a set of sample properties in your account
+          # from the pool of sample properties defined by EPA and NRCan
+          # respectively. The actual number of properties created may differ
+          # from the count that you specify due to a sample property containing
+          # child properties that will also be created. This web service is only
+          # available within the Test environment. You can only create a maximum
+          # of 100 sample properties per request and no more than 1000
+          # properties may exist in your account to invoke this service.
+          #
+          # @param country_code [nil, "US", "CA"]
+          # @param create_count [nil, Integer]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/test/api/property/sample-testing/post
+          def create_sample_properties(country_code = nil, create_count = nil)
+            request(Net::HTTP::Post, path_for("createSampleProperties"), {
+              "countryCode" => country_code,
+              "createCount" => create_count,
+            }, {}, nil, nil, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
         end
       end
 

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::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 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 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::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]
+          # @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]
           # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
           # @raise [PortfolioManager::HTTPResponseError]
           # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/propertyUse/get
@@ -287,18 +287,140 @@ module PortfolioManager
         end
       end
 
+      # Custom Property Use and Use Details
+      module CustomPropertyUseAndUseDetails
+        # Live Environment
+        module Live
+          # Get Custom Property Use
+          #
+          # This web service returns the custom use detail information for a
+          # given property. If at least one custom use detail has not been
+          # defined then a 404 is returned. To create a new custom use detail,
+          # please {https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUseDetails/post see}. The information includes general data about the custom
+          # property use itself and its most current custom characteristics
+          # information. The corresponding property must already be shared to
+          # you.
+          #
+          # @param property_id [Integer]
+          # @return [PortfolioManager::Xml::CustomUseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUse/get
+          def get_custom_property_use(property_id)
+            request(Net::HTTP::Get, path_for("customUse", property_id), {}, {}, nil, nil, PortfolioManager::Xml::CustomUseType, basic_auth: true)
+          end
+
+          # Get Custom Use Details Revision History
+          #
+          # This web service retrieves the custom use details revision history
+          # for a specific property. The corresponding property must be already
+          # shared to you.
+          #
+          # @param property_id [Integer]
+          # @param current_as_of_start [Date]
+          # @param current_as_of_end [Date]
+          # @return [PortfolioManager::Xml::UseDetails]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUseDetailsRevisions/get
+          def get_custom_use_details_revision_history(property_id, current_as_of_start, current_as_of_end)
+            request(Net::HTTP::Get, path_for("customUse", property_id, "detailRevisions"), {
+              "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
+
+          # Edit Custom Use Detail - Revision
+          #
+          # This web service updates a specific custom use detail 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
+          # custom use detail and a link to the corresponding web service to
+          # retrieve it. The corresponding property must already be shared to
+          # you.
+          #
+          # A maximum of 2 custom use details can be created for a property. To
+          # learn more, please reference this {https://energystar.my.site.com/PortfolioManager/s/article/How-do-I-create-custom-use-details FAQ}.
+          #
+          # @param property_id [Integer]
+          # @param custom_use_details [PortfolioManager::Xml::CustomUseDetailsType]
+          # @param elename [nil, String]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUseDetails/post
+          def edit_custom_use_detail_revision(property_id, custom_use_details, elename = nil)
+            request(Net::HTTP::Post, path_for("customUse", property_id, "details"), {}, {}, custom_use_details, elename, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Get Custom Use Detail
+          #
+          # This web service retrieves specific use detail information for a
+          # given custom use detail. The corresponding property must already be
+          # shared with you.
+          #
+          # @param details_id [Integer]
+          # @return [PortfolioManager::Xml::CustomUseDetailsType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUseDetails/get
+          def get_custom_use_detail(details_id)
+            request(Net::HTTP::Get, path_for("customUse", "details", details_id), {}, {}, nil, nil, PortfolioManager::Xml::CustomUseDetailsType, basic_auth: true)
+          end
+
+          # Edit Custom Use Details - Correction
+          #
+          # This web service updates a specific custom use detail based on the
+          # information provided in the XML request. The update is performed as
+          # a correction. It returns the unique identifier to the custom use
+          # detail and a link to the corresponding web service to retrieve it.
+          # The corresponding property must already be shared to you.
+          #
+          # @param details_id [Integer]
+          # @param custom_use_details [PortfolioManager::Xml::CustomUseDetailsType]
+          # @param elename [nil, String]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUseDetails/put
+          def edit_custom_use_details_correction(details_id, custom_use_details, elename = nil)
+            request(Net::HTTP::Put, path_for("customUse", "details", details_id), {}, {}, custom_use_details, elename, PortfolioManager::Xml::ResponseType, basic_auth: true)
+          end
+
+          # Delete Custom Use Detail
+          #
+          # This web service deletes a specific custom use detail. The
+          # corresponding property must already be shared to you.
+          #
+          # @param details_id [Integer]
+          # @return [PortfolioManager::Xml::ResponseType]
+          # @raise [PortfolioManager::HTTPBasicCredentialsNotFoundError]
+          # @raise [PortfolioManager::HTTPResponseError]
+          # @see https://portfoliomanager.energystar.gov/webservices/home/api/propertyUse/customUseDetails/delete
+          def delete_custom_use_detail(details_id)
+            request(Net::HTTP::Delete, path_for("customUse", "details", detail_id), {}, {}, 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
+          include PortfolioManager::Services::PropertyUse::CustomPropertyUseAndUseDetails::Live
         end
 
         # Test Environment
         module Test
           include PortfolioManager::Services::PropertyUse::PropertyUse::Test
           include PortfolioManager::Services::PropertyUse::UseDetails::Test
+          include PortfolioManager::Services::PropertyUse::CustomPropertyUseAndUseDetails::Test
         end
       end
     end