Class: Io::Flow::V0::Models::CancelReason

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) ⇒ CancelReason

Returns a new instance of CancelReason.



16209
16210
16211
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16209

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



16207
16208
16209
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16207

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



16229
16230
16231
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16229

def CancelReason.ALL
  @@all ||= [CancelReason.out_of_stock, CancelReason.consumer_requested, CancelReason.flow_cancel]
end

.apply(value) ⇒ Object

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



16214
16215
16216
16217
16218
16219
16220
16221
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16214

def CancelReason.apply(value)
  if value.instance_of?(CancelReason)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || CancelReason.new(value))
  end
end

.consumer_requested ⇒ Object

A consumer requested cancellation of an item qty and the fulfillment party has acknowledged that the qty will not be shipped. This is a cancel of the ordered quantity and will reduce or refund the consumer’s payment



16243
16244
16245
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16243

def CancelReason.consumer_requested
  @@_consumer_requested ||= CancelReason.new('consumer_requested')
end

.flow_cancel ⇒ Object

Flow has had to cancel an order, possibly due to fraud activity or inability to collect payment. This will cancel the ordered quantity. All known parties will be notified.



16250
16251
16252
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16250

def CancelReason.flow_cancel
  @@_flow_cancel ||= CancelReason.new('flow_cancel')
end

.from_string(value) ⇒ Object

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



16224
16225
16226
16227
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16224

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

.out_of_stock ⇒ Object

Out of stock is a permanent cancel of the fulfillment of an item qty. If no other fulfillment parties exist, this will cancel the ordered quantity and reduce or refund the consumer’s payment.



16236
16237
16238
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16236

def CancelReason.out_of_stock
  @@_out_of_stock ||= CancelReason.new('out_of_stock')
end

Instance Method Details

#to_hash ⇒ Object 



16254
16255
16256
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16254

def to_hash
  value
end