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.



9235
9236
9237
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9235

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



9233
9234
9235
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9233

def value
  @value
end

Class Method Details

.ALLObject



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

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



9240
9241
9242
9243
9244
9245
9246
9247
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9240

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



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

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



9250
9251
9252
9253
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9250

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

.generic_errorObject



9259
9260
9261
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9259

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

.order_identifier_errorObject



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

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.



9267
9268
9269
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9267

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

Instance Method Details

#to_hashObject



9279
9280
9281
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9279

def to_hash
  value
end