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.



18054
18055
18056
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18054

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



18052
18053
18054
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18052

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



18074
18075
18076
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18074

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



18059
18060
18061
18062
18063
18064
18065
18066
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18059

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



18098
18099
18100
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18098

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.



18104
18105
18106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18104

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



18069
18070
18071
18072
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18069

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

.generic_error ⇒ Object 



18078
18079
18080
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18078

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.



18150
18151
18152
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18150

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



18127
18128
18129
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18127

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



18122
18123
18124
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18122

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

.invalid_language ⇒ Object

Indicates that the specified language code is not valid



18137
18138
18139
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18137

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

.invalid_region ⇒ Object

Indicates that the specified region code is not valid



18132
18133
18134
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18132

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



18144
18145
18146
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18144

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)



18092
18093
18094
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18092

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.



18086
18087
18088
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18086

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.



18110
18111
18112
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18110

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.



18157
18158
18159
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18157

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.



18117
18118
18119
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18117

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

Instance Method Details

#to_hash ⇒ Object 



18161
18162
18163
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18161

def to_hash
  value
end