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.



8582
8583
8584
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8582

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



8580
8581
8582
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8580

def value
  @value
end

Class Method Details

.ALLObject



8602
8603
8604
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8602

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



8587
8588
8589
8590
8591
8592
8593
8594
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8587

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



8597
8598
8599
8600
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8597

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

.generic_errorObject



8606
8607
8608
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8606

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

.order_identifier_errorObject



8618
8619
8620
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8618

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.



8614
8615
8616
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8614

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

Instance Method Details

#to_hashObject



8622
8623
8624
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8622

def to_hash
  value
end