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.



9275
9276
9277
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9275

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



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

def value
  @value
end

Class Method Details

.ALLObject



9295
9296
9297
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9295

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



9280
9281
9282
9283
9284
9285
9286
9287
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9280

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



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

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



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

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

.generic_errorObject



9299
9300
9301
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9299

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

.order_identifier_errorObject



9311
9312
9313
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9311

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.



9307
9308
9309
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9307

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

Instance Method Details

#to_hashObject



9319
9320
9321
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9319

def to_hash
  value
end