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.



8393
8394
8395
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8393

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



8391
8392
8393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8391

def value
  @value
end

Class Method Details

.ALLObject



8413
8414
8415
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8413

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



8398
8399
8400
8401
8402
8403
8404
8405
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8398

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



8408
8409
8410
8411
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8408

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

.generic_errorObject



8417
8418
8419
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8417

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

.order_identifier_errorObject



8429
8430
8431
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8429

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.



8425
8426
8427
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8425

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

Instance Method Details

#to_hashObject



8433
8434
8435
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8433

def to_hash
  value
end