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.



14174
14175
14176
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14174

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



14172
14173
14174
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14172

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



14194
14195
14196
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14194

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



14179
14180
14181
14182
14183
14184
14185
14186
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14179

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



14218
14219
14220
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14218

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.



14224
14225
14226
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14224

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



14189
14190
14191
14192
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14189

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

.generic_error ⇒ Object 



14198
14199
14200
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14198

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

.invalid_country ⇒ Object

Indicates that the specified country code is not valid



14247
14248
14249
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14247

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



14242
14243
14244
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14242

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

.invalid_language ⇒ Object

Indicates that the specified language code is not valid



14257
14258
14259
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14257

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

.invalid_region ⇒ Object

Indicates that the specified region code is not valid



14252
14253
14254
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14252

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)



14212
14213
14214
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14212

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.



14206
14207
14208
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14206

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.



14230
14231
14232
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14230

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.



14237
14238
14239
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14237

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

Instance Method Details

#to_hash ⇒ Object 



14261
14262
14263
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14261

def to_hash
  value
end