class Io::Flow::V0::Models::OrderErrorCode

Attributes

value[R]

Public Class Methods

ALL() click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 22975
def OrderErrorCode.ALL
  @@all ||= [OrderErrorCode.generic_error, OrderErrorCode.order_item_not_available, OrderErrorCode.order_identifier_error, OrderErrorCode.authorization_invalid, OrderErrorCode.domestic_shipping_unavailable, OrderErrorCode.shipping_unavailable, OrderErrorCode.value_threshold_exceeded, OrderErrorCode.invalid_currency, OrderErrorCode.invalid_country, OrderErrorCode.invalid_region, OrderErrorCode.invalid_language, OrderErrorCode.item_out_of_stock, OrderErrorCode.gift_card_not_accepted, OrderErrorCode.total_changed]
end
apply(value) click to toggle source

Returns the instance of OrderErrorCode for this value, creating a new instance for an unknown value

# File lib/flow_commerce/flow_api_v0_client.rb, line 22960
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
authorization_invalid() click to toggle source

The authorization key specified is invalid - either because it does not exist or is not associated with this order

# File lib/flow_commerce/flow_api_v0_client.rb, line 22999
def OrderErrorCode.authorization_invalid
  @@_authorization_invalid ||= OrderErrorCode.new('authorization_invalid')
end
domestic_shipping_unavailable() click to toggle source

Indicates that an order was created for a country for one of your domicile countries and you have asked Flow not to accept orders for this country.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23005
def OrderErrorCode.domestic_shipping_unavailable
  @@_domestic_shipping_unavailable ||= OrderErrorCode.new('domestic_shipping_unavailable')
end
from_string(value) click to toggle source

Returns the instance of OrderErrorCode for this value, or nil if not found

# File lib/flow_commerce/flow_api_v0_client.rb, line 22970
def OrderErrorCode.from_string(value)
  HttpClient::Preconditions.assert_class('value', value, String)
  OrderErrorCode.ALL.find { |v| v.value == value }
end
generic_error() click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 22979
def OrderErrorCode.generic_error
  @@_generic_error ||= OrderErrorCode.new('generic_error')
end
gift_card_not_accepted() click to toggle source

Indicates a failure to charge a gift card. Error message will indicate when retries are possible.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23051
def OrderErrorCode.gift_card_not_accepted
  @@_gift_card_not_accepted ||= OrderErrorCode.new('gift_card_not_accepted')
end
invalid_country() click to toggle source

Indicates that the specified country code is not valid

# File lib/flow_commerce/flow_api_v0_client.rb, line 23028
def OrderErrorCode.invalid_country
  @@_invalid_country ||= OrderErrorCode.new('invalid_country')
end
invalid_currency() click to toggle source

Indicates that the specified currency code is not valid

# File lib/flow_commerce/flow_api_v0_client.rb, line 23023
def OrderErrorCode.invalid_currency
  @@_invalid_currency ||= OrderErrorCode.new('invalid_currency')
end
invalid_language() click to toggle source

Indicates that the specified language code is not valid

# File lib/flow_commerce/flow_api_v0_client.rb, line 23038
def OrderErrorCode.invalid_language
  @@_invalid_language ||= OrderErrorCode.new('invalid_language')
end
invalid_region() click to toggle source

Indicates that the specified region code is not valid

# File lib/flow_commerce/flow_api_v0_client.rb, line 23033
def OrderErrorCode.invalid_region
  @@_invalid_region ||= OrderErrorCode.new('invalid_region')
end
item_out_of_stock() click to toggle source

Indicates that one or more ordered items is marked as out-of-stock or otherwise cannot be reserved. We will list the specific out-of-stock items in the numbers field

# File lib/flow_commerce/flow_api_v0_client.rb, line 23045
def OrderErrorCode.item_out_of_stock
  @@_item_out_of_stock ||= OrderErrorCode.new('item_out_of_stock')
end
new(value) click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 22955
def initialize(value)
  @value = HttpClient::Preconditions.assert_class('value', value, String)
end
order_identifier_error() click to toggle source

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

# File lib/flow_commerce/flow_api_v0_client.rb, line 22993
def OrderErrorCode.order_identifier_error
  @@_order_identifier_error ||= OrderErrorCode.new('order_identifier_error')
end
order_item_not_available() click to toggle source

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.

# File lib/flow_commerce/flow_api_v0_client.rb, line 22987
def OrderErrorCode.order_item_not_available
  @@_order_item_not_available ||= OrderErrorCode.new('order_item_not_available')
end
shipping_unavailable() click to toggle source

Indicates that an order was created for a country to which you have asked Flow not to ship.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23011
def OrderErrorCode.shipping_unavailable
  @@_shipping_unavailable ||= OrderErrorCode.new('shipping_unavailable')
end
total_changed() click to toggle source

Indicates that the order total has changed, likely due to pricebook update or rate change. This is not an error but the consumer should be shown the new price before continuing checkout.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23058
def OrderErrorCode.total_changed
  @@_total_changed ||= OrderErrorCode.new('total_changed')
end
value_threshold_exceeded() click to toggle source

Indicates the order value exceeds the value threshold for destination and cannot be shipped. When specified, the order will also populate the threshold attribute.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23018
def OrderErrorCode.value_threshold_exceeded
  @@_value_threshold_exceeded ||= OrderErrorCode.new('value_threshold_exceeded')
end

Public Instance Methods

to_hash() click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 23062
def to_hash
  value
end