portfolio_manager 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11e10b4cc1d39ef7786f32cb008592026541cf755281d8cbdccf24158c7241d
-  data.tar.gz: 9e85f566088fcd0ef283e4d11a6fbea65c1c15c7ecb705ff7b55cbf0a13e1978
+  metadata.gz: 3e54963fc5c067a77654a9f85987306461782751a7ec82fa155e3e01d2fed6bc
+  data.tar.gz: febc5bd8568aa7ace57bf2a4f2a93586312cbae8acdeb155ceae4065aa93e2c9
 SHA512:
-  metadata.gz: 174a443420fd097fb6df1aebd5cf6468795619c5afc2f4ebc0bb4e00517490c152d2297d38ff7bac8810a8b15b42b90e5cf1717b6b6522790ab6662e8b7e14bf
-  data.tar.gz: 8201b5eb4197ed16def24025a4e5d13599ba46c89234f7ba47911fd6e2e92b08d06c6dbc2808280f931eb51a063d49ac52fdbe3bb3f5f5edb4ca29035bffab62
+  metadata.gz: 00146adc34b5281c9b7eea69440425f7848626c9b2b5f3ada3ee9174202b4994b1e3d4c6f89ae9992e629ce8c0ea4a94ec2e6cb9dbdcafb23c5b7c1d49187476
+  data.tar.gz: aa096c71717824ea611aa6795fe7c71e7dbf851d37db6b547e89aa748f39612624246a652482d9691ea3c0d3b6674348708dfc7370a6b4accbdd6f7a9eaed06f

data/README.md

@@ -62,10 +62,14 @@ GET | /property/(propertyId)/building/list | `building_list(property_id)` | Retu
 #### Meter Services
 http://portfoliomanager.energystar.gov/webservices/home/api/meter
 
+
 HTTP | Path | Method | Description
 ---- | ---- | ------ | -----------
+GET | /customer/(customerId)/meter/whatChanged?date=(YYYY-MM-DD) | `what_changed_meter_list(customer_id, date, next_page_key: nil, previous_page_key: nil)` |  Returns a list of meters that have been modified since a specified date.
 GET | /meter/(meterId) | `meter(meter_id)` | 	Returns information for a specified meter.
 GET | /property/(propertyId)/meter/list	| `meter_list(property_id)` | Returns a list of meters for a specified property.
+GET | /property/(propertyId)/meter/whatChanged?date=(YYYY-MM-DD) | `what_changed_meter_list_for_property(property_id, date, next_page_key: nil, previous_page_key: nil)` |  Returns a list of meters that have been modified since a specified date, for a specified property.
+GET | /customer/(customerId)/meter/consumptionData/whatChanged?date=(YYYY-MM-DD) | `what_changed_consumption_data_meter_list(customer_id, date, next_page_key: nil, previous_page_key: nil)` | Returns a list of meters for a specified customer that have had their consumption data modified since a specified date.
 GET | /meter/(meterId)/consumptionData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) | `consumption_data(meter_id, page: nil, start_date: nil, end_date: nil)` | Returns the consumption data for a specified meter in sets of 120.
 
 #### Reporting Services

data/lib/portfolio_manager/rest/meter.rb

@@ -29,10 +29,45 @@ module PortfolioManager
         perform_get_request("/property/#{property_id}/meter/list")
       end
 
+      ##
+      # This web service returns a list of meters that changed since a user specified date. The list of meters returned are account specific.
+      # The returned list only shows meters that you have permission to view. Results are returned in increments of 1,000 per set.
+      #
+      # Dates must be formatted as YYYY-MM-DD
+      #
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/meter/getWhatChanged/get
+      # pagination template:
+      # "/customer/#{customerId}/meter/whatChanged?nextPageKey=#{next_page_key}&date=#{date}"
+      def what_changed_meter_list(customer_id, date, next_page_key: nil, previous_page_key: nil)
+        query_string = URI.encode_www_form({ date: date, nextPageKey: next_page_key, previousPageKey: previous_page_key }.reject! {|k,v| v.nil?})
+        resource_path = "/customer/#{customer_id}/meter/whatChanged"
+        link = query_string.empty? ? resource_path : "#{resource_path}?#{query_string}"
+        perform_get_request(link)
+      end
+
+      ##
+      # This web service returns a list of meters within a specified property that changed since a user specified date. The list of meters returned are property specific.
+      # The returned list only shows meters that you have permission to view. Results are returned in increments of 1,000 per set.
+      #
+      # Dates must be formatted as YYYY-MM-DD
+      #
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/meter/getWhatChanged/get
+      # pagination template:
+      # "/property/#{propertyId}/meter/whatChanged?nextPageKey=#{next_page_key}&date=#{date}"
+      def what_changed_meter_list_for_property(property_id, date, next_page_key: nil, previous_page_key: nil)
+        query_string = URI.encode_www_form({ date: date, nextPageKey: next_page_key, previousPageKey: previous_page_key }.reject! {|k,v| v.nil?})
+        resource_path = "/property/#{property_id}/meter/whatChanged"
+        link = query_string.empty? ? resource_path : "#{resource_path}?#{query_string}"
+        perform_get_request(link)
+      end
+
       ##
       # This web service retrieves a list of consumption data for a specific
       # meter. The meter must already be shared with you.
       #
+      # The consumption data is returned in sets of 120. An optional date range can specified to return a certain set of consumption records.
+      # Dates must be formatted as YYYY-MM-DD
+      #
       # @see https://portfoliomanager.energystar.gov/webservices/home/api/meter/consumptionData/get
       # page_link template:
       # "/meter/#{meter_id}/consumptionData/?page=#{page}&startDate=#{start_date}&endDate=#{end_date}"
@@ -42,6 +77,22 @@ module PortfolioManager
         link = query_string.empty? ? resource_path : "#{resource_path}?#{query_string}"
         perform_get_request(link)
       end
+
+      ##
+      # This web service returns a list of meters that have had their consumption data changed since a user specified date. The list of meters returned are account specific.
+      # The returned list only shows meters that you have permission to view. Results are returned in increments of 1,000 per set.
+      #
+      # Dates must be formatted as YYYY-MM-DD
+      #
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/meter/consumptionDataGetWhatChanged/get
+      # pagination template:
+      # "/customer/#{customerId}/meter/consumptionData/whatChanged?nextPageKey=#{next_page_key}&date=#{date}"
+      def what_changed_consumption_data_meter_list(customer_id, date, next_page_key: nil, previous_page_key: nil)
+        query_string = URI.encode_www_form({ date: date, nextPageKey: next_page_key, previousPageKey: previous_page_key }.reject! {|k,v| v.nil?})
+        resource_path = "/customer/#{customer_id}/meter/consumptionData/whatChanged"
+        link = query_string.empty? ? resource_path : "#{resource_path}?#{query_string}"
+        perform_get_request(link)
+      end
     end
   end
 end

data/lib/portfolio_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PortfolioManager
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portfolio_manager
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jack Reed
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2025-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,7 +144,7 @@ homepage: https://github.com/mejackreed/portfolio_manager
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -159,8 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A Ruby client for the EnergyStar Portfolio Manager web services.
 test_files: []