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



9316
9317
9318
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9316

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



9314
9315
9316
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9314

def value
  @value
end

Class Method Details

.ALLObject



9336
9337
9338
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9336

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



9321
9322
9323
9324
9325
9326
9327
9328
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9321

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

Indicates that an order was created for a country to which you have asked Flow not to ship. Usually this indicates an error that a request was made to create an order for your domestic country



9361
9362
9363
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9361

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



9331
9332
9333
9334
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9331

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

.generic_errorObject



9340
9341
9342
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9340

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

.order_identifier_errorObject

Indicates that there is no order with the specified number (nor an order for which an order identifier with that number has been created)



9354
9355
9356
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9354

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.



9348
9349
9350
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9348

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

Instance Method Details

#to_hashObject



9365
9366
9367
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9365

def to_hash
  value
end