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.



8400
8401
8402
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8400

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



8398
8399
8400
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8398

def value
  @value
end

Class Method Details

.ALLObject



8420
8421
8422
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8420

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



8405
8406
8407
8408
8409
8410
8411
8412
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8405

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



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

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

.generic_errorObject



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

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

.order_identifier_errorObject



8436
8437
8438
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8436

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.



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

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

Instance Method Details

#to_hashObject



8440
8441
8442
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8440

def to_hash
  value
end