Class: Io::Flow::V0::Models::ShipmentRecipient

Inherits:

Object

• Object
• Io::Flow::V0::Models::ShipmentRecipient

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Instance Attribute Summary

• #value ⇒ Object readonly

  Returns the value of attribute value.

Class Method Summary

• .ALL ⇒ Object
• .apply(value) ⇒ Object

  Returns the instance of ShipmentRecipient for this value, creating a new instance for an unknown value.

• .crossdock ⇒ Object

  Outbound shipment to a crossdock.

• .customer ⇒ Object

  Outbound shipment to the customer.

• .from_string(value) ⇒ Object

  Returns the instance of ShipmentRecipient for this value, or nil if not found.

• .return ⇒ Object

  Inbound or return shipment.

Instance Method Summary

• #initialize(value) ⇒ ShipmentRecipient constructor

  A new instance of ShipmentRecipient.

• #to_hash ⇒ Object

Constructor Details

#initialize(value) ⇒ ShipmentRecipient

Returns a new instance of ShipmentRecipient.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19103

def initialize(value)
  @value = HttpClient::Preconditions.assert_class('value', value, String)
end

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19101

def value
  @value
end

Class Method Details

.ALL ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19123

def ShipmentRecipient.ALL
  @@all ||= [ShipmentRecipient.customer, ShipmentRecipient.return, ShipmentRecipient.crossdock]
end

.apply(value) ⇒ Object

Returns the instance of ShipmentRecipient for this value, creating a new instance for an unknown value

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19108

def ShipmentRecipient.apply(value)
  if value.instance_of?(ShipmentRecipient)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || ShipmentRecipient.new(value))
  end
end

.crossdock ⇒ Object

Outbound shipment to a crossdock

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19138

def ShipmentRecipient.crossdock
  @@_crossdock ||= ShipmentRecipient.new('crossdock')
end

.customer ⇒ Object

Outbound shipment to the customer

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19128

def ShipmentRecipient.customer
  @@_customer ||= ShipmentRecipient.new('customer')
end

.from_string(value) ⇒ Object

Returns the instance of ShipmentRecipient for this value, or nil if not found

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19118

def ShipmentRecipient.from_string(value)
  HttpClient::Preconditions.assert_class('value', value, String)
  ShipmentRecipient.ALL.find { |v| v.value == value }
end

.return ⇒ Object

Inbound or return shipment

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19133

def ShipmentRecipient.return
  @@_return ||= ShipmentRecipient.new('return')
end

Instance Method Details

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19142

def to_hash
  value
end