goshippo/shippo-ruby-client

View on GitHub
lib/shippo/api/operations/list.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Shippo
  module API
    module Operations
      module List
        # Return all items
        # @param [Hash] params of additional URI parameters tacked onto the query URL
        def all(params={})
          response = Shippo::API.get("#{url}/", params)
          self.from(response)
        end

        # Retrieve a concrete item by it's ID
        # @param [Fixnum] id database ID of the item to be retrieved
        # @param [Hash] params of additional URI parameters tacked onto the query URL
        def get(id, params={})
          response = Shippo::API.get("#{url}/#{CGI.escape(id)}/", params)
          self.from(response)
        end
      end
    end
  end
end