Class: Io::Flow::V0::Models::Carrier

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

Partner that actually take a shipment between places (ex: FedEx, DHL, SF Express)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Carrier

Returns a new instance of Carrier.



12212
12213
12214
12215
12216
12217
12218
12219
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12212

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :name, :facilities, :visibility], 'Carrier')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
  @facilities = HttpClient::Preconditions.assert_class('facilities', opts.delete(:facilities), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ShippingAddress) ? x : ::Io::Flow::V0::Models::ShippingAddress.new(x)) }
  @visibility = (x = opts.delete(:visibility); x.is_a?(::Io::Flow::V0::Models::Visibility) ? x : ::Io::Flow::V0::Models::Visibility.apply(x))
end

Instance Attribute Details

#facilities ⇒ Object (readonly)

Returns the value of attribute facilities.



12210
12211
12212
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12210

def facilities
  @facilities
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



12210
12211
12212
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12210

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



12210
12211
12212
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12210

def name
  @name
end

#visibility ⇒ Object (readonly)

Returns the value of attribute visibility.



12210
12211
12212
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12210

def visibility
  @visibility
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



12225
12226
12227
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12225

def copy(incoming={})
  Carrier.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



12229
12230
12231
12232
12233
12234
12235
12236
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12229

def to_hash
  {
    :id => id,
    :name => name,
    :facilities => facilities.map { |o| o.to_hash },
    :visibility => visibility.value
  }
end

#to_json ⇒ Object 



12221
12222
12223
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12221

def to_json
  JSON.dump(to_hash)
end