Class: Io::Flow::V0::Models::OrderErrorCode

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value) ⇒ OrderErrorCode

Returns a new instance of OrderErrorCode.



9674
9675
9676
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9674

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



9672
9673
9674
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9672

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



9694
9695
9696
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9694

def OrderErrorCode.ALL
  @@all ||= [OrderErrorCode.generic_error, OrderErrorCode.order_item_not_available, OrderErrorCode.order_identifier_error, OrderErrorCode.domestic_shipping_unavailable, OrderErrorCode.value_threshold_exceeded]
end

.apply(value) ⇒ Object

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



9679
9680
9681
9682
9683
9684
9685
9686
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9679

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

.domestic_shipping_unavailable ⇒ Object

Indicates that an order was created for a country to which you have asked Flow not to ship. Usually this indicates an error that a request was made to create an order for your domestic country



9719
9720
9721
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9719

def OrderErrorCode.domestic_shipping_unavailable
  @@_domestic_shipping_unavailable ||= OrderErrorCode.new('domestic_shipping_unavailable')
end

.from_string(value) ⇒ Object

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



9689
9690
9691
9692
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9689

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

.generic_error ⇒ Object 



9698
9699
9700
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9698

def OrderErrorCode.generic_error
  @@_generic_error ||= OrderErrorCode.new('generic_error')
end

.order_identifier_error ⇒ Object

Indicates that there is no order with the specified number (nor an order for which an order identifier with that number has been created)



9712
9713
9714
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9712

def OrderErrorCode.order_identifier_error
  @@_order_identifier_error ||= OrderErrorCode.new('order_identifier_error')
end

.order_item_not_available ⇒ Object

When creating an order, if a particular item is not available in the country / destination (either because it was restricted or excluded from that country), we return this error code and list the specific item numbers which are not available in the ‘numbers’ field.



9706
9707
9708
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9706

def OrderErrorCode.order_item_not_available
  @@_order_item_not_available ||= OrderErrorCode.new('order_item_not_available')
end

.value_threshold_exceeded ⇒ Object

Indicates the order value exceeds the value threshold for destination and cannot be shipped.



9725
9726
9727
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9725

def OrderErrorCode.value_threshold_exceeded
  @@_value_threshold_exceeded ||= OrderErrorCode.new('value_threshold_exceeded')
end

Instance Method Details

#to_hash ⇒ Object 



9729
9730
9731
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9729

def to_hash
  value
end