Module: PortfolioManager::REST::Share

Includes:

Utils

Included in:

API

Defined in:

lib/portfolio_manager/rest/share.rb

Overview

Share services

See Also:

• https://portfoliomanager.energystar.gov/webservices/home/api/connection

Instance Method Summary

• #meter_share_request(meter_id, accept = true) ⇒ Object

  Accepts/rejects a pending share request for a specific property or meter.

• #pending_meter_shares(link = nil) ⇒ Object

  Returns a list of property or meter share requests that are pending.

• #pending_property_shares(link = nil) ⇒ Object
• #property_share_request(property_id, accept = true) ⇒ Object

Instance Method Details

#meter_share_request(meter_id, accept = true) ⇒ Object

Accepts/rejects a pending share request for a specific property or meter.

See Also:

• https://portfoliomanager.energystar.gov/webservices/home/api/connection/shareProperty/post
• https://portfoliomanager.energystar.gov/webservices/home/api/connection/shareMeter/post

# File 'lib/portfolio_manager/rest/share.rb', line 31

def meter_share_request(meter_id, accept = true)
  share_request(meter_id, :meter, accept)
end

#pending_meter_shares(link = nil) ⇒ Object

Returns a list of property or meter share requests that are pending. These property share requests belong to customers that you are already connected to. The list of pending property share requests is returned in sets of 20.

See Also:

• https://portfoliomanager.energystar.gov/webservices/home/api/connection/pendingPropertyList/get
• https://portfoliomanager.energystar.gov/webservices/home/api/connection/pendingMeterList/get

# File 'lib/portfolio_manager/rest/share.rb', line 18

def pending_meter_shares(link = nil)
  pending_shares(:meter, link)
end

#pending_property_shares(link = nil) ⇒ Object

# File 'lib/portfolio_manager/rest/share.rb', line 22

def pending_property_shares(link = nil)
  pending_shares(:property, link)
end

#property_share_request(property_id, accept = true) ⇒ Object

# File 'lib/portfolio_manager/rest/share.rb', line 35

def property_share_request(property_id, accept = true)
  share_request(property_id, :property, accept)
end