Class: EasyPost::Services::CarrierMetadata

Inherits:
Service
  • Object
show all
Defined in:
lib/easypost/services/carrier_metadata.rb

Instance Method Summary collapse

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from EasyPost::Services::Service

Instance Method Details

#retrieve(carriers = [], types = []) ⇒ Object

Retrieve metadata for carrier(s).



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/easypost/services/carrier_metadata.rb', line 5

def retrieve(carriers = [], types = [])
  path = '/metadata/carriers?'
  params = {}

  if carriers.length.positive?
    params[:carriers] = carriers.join(',')
  end

  if types.length.positive?
    params[:types] = types.join(',')
  end

  path += URI.encode_www_form(params)
  response = @client.make_request(:get, path, params)

  EasyPost::InternalUtilities::Json.convert_json_to_object(response).carriers
end