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.



10900
10901
10902
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10900

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



10898
10899
10900
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10898

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



10920
10921
10922
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10920

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, 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



10905
10906
10907
10908
10909
10910
10911
10912
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10905

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



10944
10945
10946
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10944

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



10951
10952
10953
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10951

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



10915
10916
10917
10918
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10915

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

.generic_error ⇒ Object 



10924
10925
10926
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10924

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

.invalid_country ⇒ Object

Indicates that the specified country code is not valid



10968
10969
10970
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10968

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



10963
10964
10965
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10963

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

.invalid_language ⇒ Object

Indicates that the specified language code is not valid



10978
10979
10980
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10978

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

.invalid_region ⇒ Object

Indicates that the specified region code is not valid



10973
10974
10975
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10973

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)



10938
10939
10940
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10938

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.



10932
10933
10934
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10932

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.



10958
10959
10960
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10958

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

Instance Method Details

#to_hash ⇒ Object 



10982
10983
10984
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10982

def to_hash
  value
end