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.



17694
17695
17696
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17694

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



17692
17693
17694
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17692

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



17714
17715
17716
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17714

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



17699
17700
17701
17702
17703
17704
17705
17706
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17699

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



17738
17739
17740
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17738

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.



17744
17745
17746
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17744

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



17709
17710
17711
17712
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17709

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

.generic_error ⇒ Object 



17718
17719
17720
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17718

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.



17790
17791
17792
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17790

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



17767
17768
17769
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17767

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



17762
17763
17764
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17762

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

.invalid_language ⇒ Object

Indicates that the specified language code is not valid



17777
17778
17779
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17777

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

.invalid_region ⇒ Object

Indicates that the specified region code is not valid



17772
17773
17774
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17772

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



17784
17785
17786
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17784

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)



17732
17733
17734
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17732

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.



17726
17727
17728
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17726

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.



17750
17751
17752
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17750

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.



17797
17798
17799
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17797

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.



17757
17758
17759
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17757

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

Instance Method Details

#to_hash ⇒ Object 



17801
17802
17803
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17801

def to_hash
  value
end