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 takes 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.



16037
16038
16039
16040
16041
16042
16043
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16037

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :name, :tracking_url], 'Carrier')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
  @tracking_url = HttpClient::Preconditions.assert_class('tracking_url', opts.delete(:tracking_url), String)
end

Instance Attribute Details

#idObject (readonly)

Returns the value of attribute id.



16035
16036
16037
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16035

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.



16035
16036
16037
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16035

def name
  @name
end

#tracking_urlObject (readonly)

Returns the value of attribute tracking_url.



16035
16036
16037
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16035

def tracking_url
  @tracking_url
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



16049
16050
16051
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16049

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

#to_hashObject



16053
16054
16055
16056
16057
16058
16059
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16053

def to_hash
  {
    :id => id,
    :name => name,
    :tracking_url => tracking_url
  }
end

#to_jsonObject



16045
16046
16047
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16045

def to_json
  JSON.dump(to_hash)
end