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.



8109
8110
8111
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8109

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



8107
8108
8109
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8107

def value
  @value
end

Class Method Details

.ALLObject



8129
8130
8131
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8129

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



8114
8115
8116
8117
8118
8119
8120
8121
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8114

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



8124
8125
8126
8127
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8124

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

.generic_errorObject



8133
8134
8135
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8133

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

.order_identifier_errorObject



8145
8146
8147
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8145

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.



8141
8142
8143
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8141

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

Instance Method Details

#to_hashObject



8149
8150
8151
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8149

def to_hash
  value
end