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.



9100
9101
9102
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9100

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



9098
9099
9100
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9098

def value
  @value
end

Class Method Details

.ALLObject



9120
9121
9122
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9120

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



9105
9106
9107
9108
9109
9110
9111
9112
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9105

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



9140
9141
9142
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9140

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



9115
9116
9117
9118
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9115

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

.generic_errorObject



9124
9125
9126
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9124

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

.order_identifier_errorObject



9136
9137
9138
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9136

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.



9132
9133
9134
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9132

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

Instance Method Details

#to_hashObject



9144
9145
9146
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9144

def to_hash
  value
end