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.



9257
9258
9259
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9257

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



9255
9256
9257
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9255

def value
  @value
end

Class Method Details

.ALLObject



9277
9278
9279
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9277

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



9262
9263
9264
9265
9266
9267
9268
9269
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9262

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



9297
9298
9299
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9297

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



9272
9273
9274
9275
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9272

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

.generic_errorObject



9281
9282
9283
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9281

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

.order_identifier_errorObject



9293
9294
9295
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9293

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.



9289
9290
9291
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9289

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

Instance Method Details

#to_hashObject



9301
9302
9303
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9301

def to_hash
  value
end