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.



21154
21155
21156
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21154

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



21152
21153
21154
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21152

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



21174
21175
21176
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21174

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

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



21159
21160
21161
21162
21163
21164
21165
21166
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21159

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



21198
21199
21200
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21198

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.



21204
21205
21206
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21204

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



21169
21170
21171
21172
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21169

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

.generic_error ⇒ Object 



21178
21179
21180
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21178

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

.gift_card_not_accepted ⇒ Object

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



21250
21251
21252
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21250

def OrderErrorCode.gift_card_not_accepted
  @@_gift_card_not_accepted ||= OrderErrorCode.new('gift_card_not_accepted')
end

.invalid_country ⇒ Object

Indicates that the specified country code is not valid



21227
21228
21229
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21227

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



21222
21223
21224
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21222

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

.invalid_language ⇒ Object

Indicates that the specified language code is not valid



21237
21238
21239
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21237

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

.invalid_region ⇒ Object

Indicates that the specified region code is not valid



21232
21233
21234
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21232

def OrderErrorCode.invalid_region
  @@_invalid_region ||= OrderErrorCode.new('invalid_region')
end

.item_out_of_stock ⇒ Object

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



21244
21245
21246
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21244

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



21192
21193
21194
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21192

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.



21186
21187
21188
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21186

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.



21210
21211
21212
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21210

def OrderErrorCode.shipping_unavailable
  @@_shipping_unavailable ||= OrderErrorCode.new('shipping_unavailable')
end

.total_changed ⇒ Object

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.



21257
21258
21259
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21257

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



21217
21218
21219
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21217

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

Instance Method Details

#to_hash ⇒ Object 



21261
21262
21263
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21261

def to_hash
  value
end