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 



13161
13162
13163
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13161

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



13159
13160
13161
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13159

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



13181
13182
13183
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13181

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



13166
13167
13168
13169
13170
13171
13172
13173
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13166

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



13205
13206
13207
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13205

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.



13211
13212
13213
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13211

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



13176
13177
13178
13179
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13176

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

.generic_error ⇒ Object 



13185
13186
13187
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13185

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

.invalid_country ⇒ Object

Indicates that the specified country code is not valid



13234
13235
13236
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13234

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



13229
13230
13231
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13229

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

.invalid_language ⇒ Object

Indicates that the specified language code is not valid



13244
13245
13246
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13244

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

.invalid_region ⇒ Object

Indicates that the specified region code is not valid



13239
13240
13241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13239

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)



13199
13200
13201
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13199

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.



13193
13194
13195
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13193

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.



13217
13218
13219
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13217

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.



13224
13225
13226
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13224

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

Instance Method Details

#to_hash ⇒ Object 



13248
13249
13250
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13248

def to_hash
  value
end