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.



7398
7399
7400
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7398

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



7396
7397
7398
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7396

def value
  @value
end

Class Method Details

.ALLObject



7418
7419
7420
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7418

def OrderErrorCode.ALL
  @@all ||= [OrderErrorCode.generic_error, OrderErrorCode.order_item_not_available, OrderErrorCode.order_identifier_error]
end

.apply(value) ⇒ Object

Returns the instance of OrderErrorCode for this value, creating a new instance for an unknown value



7403
7404
7405
7406
7407
7408
7409
7410
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7403

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

.from_string(value) ⇒ Object

Returns the instance of OrderErrorCode for this value, or nil if not found



7413
7414
7415
7416
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7413

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

.generic_errorObject



7422
7423
7424
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7422

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

.order_identifier_errorObject



7434
7435
7436
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7434

def OrderErrorCode.order_identifier_error
  @@_order_identifier_error ||= OrderErrorCode.new('order_identifier_error')
end

.order_item_not_availableObject

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.



7430
7431
7432
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7430

def OrderErrorCode.order_item_not_available
  @@_order_item_not_available ||= OrderErrorCode.new('order_item_not_available')
end

Instance Method Details

#to_hashObject



7438
7439
7440
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7438

def to_hash
  value
end