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.



8772
8773
8774
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8772

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



8770
8771
8772
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8770

def value
  @value
end

Class Method Details

.ALLObject



8792
8793
8794
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8792

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

.apply(value) ⇒ Object

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



8777
8778
8779
8780
8781
8782
8783
8784
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8777

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

.from_string(value) ⇒ Object

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



8787
8788
8789
8790
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8787

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

.generic_errorObject



8796
8797
8798
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8796

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

.order_identifier_errorObject



8808
8809
8810
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8808

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

.order_item_not_availableObject

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.



8804
8805
8806
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8804

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

Instance Method Details

#to_hashObject



8812
8813
8814
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8812

def to_hash
  value
end