Module: Shippo::API::Operations::List

Defined in:
lib/shippo/api/operations/list.rb

Instance Method Summary collapse

Instance Method Details

#all(params = {}) ⇒ Object

Return all items

Parameters:

  • params (Hash) (defaults to: {}) —

    of additional URI parameters tacked onto the query URL



7
8
9
10
 
# File 'lib/shippo/api/operations/list.rb', line 7

def all(params={})
  response = Shippo::API.get("#{url}/", params)
  self.from(response)
end

#get(id, params = {}) ⇒ Object

Retrieve a concrete item by it’s ID

Parameters:

  • id (Fixnum) —

    database ID of the item to be retrieved

  • params (Hash) (defaults to: {}) —

    of additional URI parameters tacked onto the query URL



15
16
17
18
 
# File 'lib/shippo/api/operations/list.rb', line 15

def get(id, params={})
  response = Shippo::API.get("#{url}/#{CGI.escape(id)}/", params)
  self.from(response)
end