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.



13573
13574
13575
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13573

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



13571
13572
13573
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13571

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



13593
13594
13595
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13593

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



13578
13579
13580
13581
13582
13583
13584
13585
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13578

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



13617
13618
13619
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13617

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.



13623
13624
13625
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13623

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



13588
13589
13590
13591
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13588

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

.generic_error ⇒ Object 



13597
13598
13599
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13597

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

.invalid_country ⇒ Object

Indicates that the specified country code is not valid



13646
13647
13648
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13646

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



13641
13642
13643
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13641

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

.invalid_language ⇒ Object

Indicates that the specified language code is not valid



13656
13657
13658
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13656

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

.invalid_region ⇒ Object

Indicates that the specified region code is not valid



13651
13652
13653
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13651

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)



13611
13612
13613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13611

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.



13605
13606
13607
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13605

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.



13629
13630
13631
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13629

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.



13636
13637
13638
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13636

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

Instance Method Details

#to_hash ⇒ Object 



13660
13661
13662
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13660

def to_hash
  value
end