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.



13094
13095
13096
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13094

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



13092
13093
13094
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13092

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



13114
13115
13116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13114

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]
end

.apply(value) ⇒ Object

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



13099
13100
13101
13102
13103
13104
13105
13106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13099

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



13138
13139
13140
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13138

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

.domestic_shipping_unavailable ⇒ Object

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.



13144
13145
13146
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13144

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



13109
13110
13111
13112
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13109

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

.generic_error ⇒ Object 



13118
13119
13120
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13118

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

.invalid_country ⇒ Object

Indicates that the specified country code is not valid



13167
13168
13169
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13167

def OrderErrorCode.invalid_country
  @@_invalid_country ||= OrderErrorCode.new('invalid_country')
end

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



13162
13163
13164
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13162

def OrderErrorCode.invalid_currency
  @@_invalid_currency ||= OrderErrorCode.new('invalid_currency')
end

.invalid_language ⇒ Object

Indicates that the specified language code is not valid



13177
13178
13179
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13177

def OrderErrorCode.invalid_language
  @@_invalid_language ||= OrderErrorCode.new('invalid_language')
end

.invalid_region ⇒ Object

Indicates that the specified region code is not valid



13172
13173
13174
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13172

def OrderErrorCode.invalid_region
  @@_invalid_region ||= OrderErrorCode.new('invalid_region')
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)



13132
13133
13134
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13132

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.



13126
13127
13128
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13126

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

.shipping_unavailable ⇒ Object

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



13150
13151
13152
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13150

def OrderErrorCode.shipping_unavailable
  @@_shipping_unavailable ||= OrderErrorCode.new('shipping_unavailable')
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.



13157
13158
13159
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13157

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

Instance Method Details

#to_hash ⇒ Object 



13181
13182
13183
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13181

def to_hash
  value
end