Class: ShipEngine::Domain::Carriers

Inherits:
Object
  • Object
show all
Defined in:
lib/shipengine/domain/carriers.rb,
lib/shipengine/domain/carriers/list_carriers.rb

Defined Under Namespace

Modules: ListCarriers

Instance Method Summary collapse

Constructor Details

#initialize(internal_client) ⇒ Carriers

Returns a new instance of Carriers.

Parameters:



11
12
13
 
# File 'lib/shipengine/domain/carriers.rb', line 11

def initialize(internal_client)
  @internal_client = internal_client
end

Instance Method Details

#list_carriers(config:) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/shipengine/domain/carriers.rb', line 15

def list_carriers(config:)
  response = @internal_client.get('/v1/carriers', {}, config)
  carriers_api_result = response.body
  mash_result = Hashie::Mash.new(carriers_api_result)
  carriers = mash_result.carriers.map do |carrier|
    services = carrier.services.map do |service|
      ListCarriers::Carrier::Service.new(
        carrier_id: service.carrier_id,
        carrier_code: service.carrier_code,
        service_code: service.service_code,
        name: service.name,
        domestic: service.domestic,
        international: service.international,
        is_multi_package_supported: service.is_multi_package_supported
      )
    end

    packages = carrier.packages.map do |package|
      dimensions = nil
      if package.dimensions
        dimensions = ListCarriers::Carrier::Package::Dimensions.new(
          unit: package.dimensions.unit,
          length: package.dimensions['length'],
          width: package.dimensions.width,
          height: package.dimensions.height
        )
      end
      ListCarriers::Carrier::Package.new(
        package_id: package.package_id,
        package_code: package.package_code,
        name: package.name,
        dimensions:,
        description: package.description
      )
    end

    options = carrier.options.map do |option|
      ListCarriers::Carrier::Option.new(
        name: option.name,
        default_value: option.default_value,
        description: option.description
      )
    end

    ListCarriers::Carrier.new(
      carrier_id: carrier.carrier_id,
      carrier_code: carrier.carrier_code,
      account_number: carrier.,
      requires_funded_amount: carrier.requires_funded_amount,
      balance: carrier.balance,
      nickname: carrier.nickname,
      friendly_name: carrier.friendly_name,
      primary: carrier.primary,
      has_multi_package_supporting_services: carrier.has_multi_package_supporting_services,
      supports_label_messages: carrier.supports_label_messages,
      services:,
      packages:,
      options:
    )
  end

  errors = mash_result.errors.map do |error|
    ListCarriers::Error.new(
      error_source: error.error_source,
      error_type: error.error_type,
      error_code: error.error_code,
      message: error['message']
    )
  end

  ListCarriers::Response.new(
    carriers:,
    request_id: mash_result.request_id,
    errors:
  )
end