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.



7974
7975
7976
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7974

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



7972
7973
7974
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7972

def value
  @value
end

Class Method Details

.ALLObject



7994
7995
7996
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7994

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



7979
7980
7981
7982
7983
7984
7985
7986
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7979

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



7989
7990
7991
7992
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7989

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

.generic_errorObject



7998
7999
8000
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7998

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

.order_identifier_errorObject



8010
8011
8012
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8010

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.



8006
8007
8008
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8006

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

Instance Method Details

#to_hashObject



8014
8015
8016
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8014

def to_hash
  value
end