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.



9184
9185
9186
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9184

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



9182
9183
9184
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9182

def value
  @value
end

Class Method Details

.ALLObject



9204
9205
9206
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9204

def OrderErrorCode.ALL
  @@all ||= [OrderErrorCode.generic_error, OrderErrorCode.order_item_not_available, OrderErrorCode.order_identifier_error, OrderErrorCode.domestic_shipping_unavailable]
end

.apply(value) ⇒ Object

Returns the instance of OrderErrorCode for this value, creating a new instance for an unknown value



9189
9190
9191
9192
9193
9194
9195
9196
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9189

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

.domestic_shipping_unavailableObject



9224
9225
9226
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9224

def OrderErrorCode.domestic_shipping_unavailable
  @@_domestic_shipping_unavailable ||= OrderErrorCode.new('domestic_shipping_unavailable')
end

.from_string(value) ⇒ Object

Returns the instance of OrderErrorCode for this value, or nil if not found



9199
9200
9201
9202
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9199

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

.generic_errorObject



9208
9209
9210
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9208

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

.order_identifier_errorObject



9220
9221
9222
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9220

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.



9216
9217
9218
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9216

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

Instance Method Details

#to_hashObject



9228
9229
9230
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9228

def to_hash
  value
end