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.



9609
9610
9611
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9609

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



9607
9608
9609
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9607

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



9629
9630
9631
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9629

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



9614
9615
9616
9617
9618
9619
9620
9621
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9614

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



9654
9655
9656
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9654

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



9624
9625
9626
9627
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9624

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

.generic_error ⇒ Object 



9633
9634
9635
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9633

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)



9647
9648
9649
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9647

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.



9641
9642
9643
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9641

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.



9660
9661
9662
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9660

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

Instance Method Details

#to_hash ⇒ Object 



9664
9665
9666
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9664

def to_hash
  value
end