Class: Io::Flow::V0::Models::OrderErrorCode

Inherits:

Object

• Object
• Io::Flow::V0::Models::OrderErrorCode

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Instance Attribute Summary

• #value ⇒ Object readonly

  Returns the value of attribute value.

Class Method Summary

• .ALL ⇒ Object
• .apply(value) ⇒ Object

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

• .authorization_invalid ⇒ Object

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

• .domestic_shipping_unavailable ⇒ Object

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

• .from_string(value) ⇒ Object

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

• .generic_error ⇒ Object
• .order_identifier_error ⇒ Object

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

• .order_item_not_available ⇒ Object

  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.

• .value_threshold_exceeded ⇒ Object

  Indicates the order value exceeds the value threshold for destination and cannot be shipped.

Instance Method Summary

• #initialize(value) ⇒ OrderErrorCode constructor

  A new instance of OrderErrorCode.

• #to_hash ⇒ Object

Constructor Details

#initialize(value) ⇒ OrderErrorCode

Returns a new instance of OrderErrorCode.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10773

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10771

def value
  @value
end

Class Method Details

.ALL ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10793

def OrderErrorCode.ALL
  @@all ||= [OrderErrorCode.generic_error, OrderErrorCode.order_item_not_available, OrderErrorCode.order_identifier_error, OrderErrorCode.authorization_invalid, OrderErrorCode.domestic_shipping_unavailable, OrderErrorCode.value_threshold_exceeded]
end

.apply(value) ⇒ Object

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 10778

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 ⇒ Object

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 10817

def OrderErrorCode.authorization_invalid
  @@_authorization_invalid ||= OrderErrorCode.new('authorization_invalid')
end

.domestic_shipping_unavailable ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10824

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10788

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

.generic_error ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10797

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

.order_identifier_error ⇒ Object

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 10811

def OrderErrorCode.order_identifier_error
  @@_order_identifier_error ||= OrderErrorCode.new('order_identifier_error')
end

.order_item_not_available ⇒ Object

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 10805

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

.value_threshold_exceeded ⇒ Object

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 10831

def OrderErrorCode.value_threshold_exceeded
  @@_value_threshold_exceeded ||= OrderErrorCode.new('value_threshold_exceeded')
end

Instance Method Details

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10835

def to_hash
  value
end