Class: ShipEngine::Domain::Carriers

Inherits:
Object
  • Object
show all
Defined in:
lib/shipengine/domains/carriers.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Carriers

Returns a new instance of Carriers.



8
9
10
 
# File 'lib/shipengine/domains/carriers.rb', line 8

def initialize
  @client = ShipEngine::Client.new
end

Instance Method Details

#add_funds_to_carrier(carrier_id:, params: {}) ⇒ Object 



30
31
32
33
34
35
36
37
 
# File 'lib/shipengine/domains/carriers.rb', line 30

def add_funds_to_carrier(carrier_id:, params: {})
  response = @client.put(
    path: "#{ShipEngine::Constants::PATHS.v1.carriers.root}/#{carrier_id}/add_funds",
    options: params
  )

  Hashie::Mash.new(response.body)
end

#carrier_by_id(carrier_id:, params: {}) ⇒ Object 



21
22
23
24
25
26
27
28
 
# File 'lib/shipengine/domains/carriers.rb', line 21

def carrier_by_id(carrier_id:, params: {})
  response = @client.get(
    path: "#{ShipEngine::Constants::PATHS.v1.carriers.root}/#{carrier_id}",
    options: params
  )

  Hashie::Mash.new(response.body)
end

#carrier_options(carrier_id:, params: {}) ⇒ Object 



39
40
41
42
43
44
45
46
 
# File 'lib/shipengine/domains/carriers.rb', line 39

def carrier_options(carrier_id:, params: {})
  response = @client.get(
    path: "#{ShipEngine::Constants::PATHS.v1.carriers.root}/#{carrier_id}/options",
    options: params
  )

  Hashie::Mash.new(response.body)
end

#list_carrier_package_types(carrier_id:, params: {}) ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'lib/shipengine/domains/carriers.rb', line 48

def list_carrier_package_types(carrier_id:, params: {})
  response = @client.get(
    path: "#{ShipEngine::Constants::PATHS.v1.carriers.root}/#{carrier_id}/packages",
    options: params
  )

  Hashie::Mash.new(response.body)
end

#list_carrier_services(carrier_id:, params: {}) ⇒ Object 



57
58
59
60
61
62
63
64
 
# File 'lib/shipengine/domains/carriers.rb', line 57

def list_carrier_services(carrier_id:, params: {})
  response = @client.get(
    path: "#{ShipEngine::Constants::PATHS.v1.carriers.root}/#{carrier_id}/services",
    options: params
  )

  Hashie::Mash.new(response.body)
end

#list_carriers(params: {}) ⇒ Object 



12
13
14
15
16
17
18
19
 
# File 'lib/shipengine/domains/carriers.rb', line 12

def list_carriers(params: {})
  response = @client.get(
    path: ShipEngine::Constants::PATHS.v1.carriers.root,
    options: params
  )

  Hashie::Mash.new(response.body)
end