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.



8671
8672
8673
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8671

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



8669
8670
8671
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8669

def value
  @value
end

Class Method Details

.ALLObject



8691
8692
8693
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8691

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



8676
8677
8678
8679
8680
8681
8682
8683
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8676

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



8686
8687
8688
8689
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8686

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

.generic_errorObject



8695
8696
8697
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8695

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

.order_identifier_errorObject



8707
8708
8709
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8707

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.



8703
8704
8705
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8703

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

Instance Method Details

#to_hashObject



8711
8712
8713
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8711

def to_hash
  value
end