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.



14183
14184
14185
14186
14187
14188
14189
14190
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14183

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

#facilitiesObject (readonly)

Returns the value of attribute facilities.



14181
14182
14183
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14181

def facilities
  @facilities
end

#idObject (readonly)

Returns the value of attribute id.



14181
14182
14183
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14181

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.



14181
14182
14183
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14181

def name
  @name
end

#visibilityObject (readonly)

Returns the value of attribute visibility.



14181
14182
14183
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14181

def visibility
  @visibility
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



14196
14197
14198
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14196

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

#to_hashObject



14200
14201
14202
14203
14204
14205
14206
14207
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14200

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

#to_jsonObject



14192
14193
14194
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14192

def to_json
  JSON.dump(to_hash)
end