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.



13674
13675
13676
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13674

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



13672
13673
13674
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13672

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



13694
13695
13696
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13694

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



13679
13680
13681
13682
13683
13684
13685
13686
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13679

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



13708
13709
13710
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13708

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.



13715
13716
13717
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13715

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



13689
13690
13691
13692
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13689

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.



13701
13702
13703
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13701

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

Instance Method Details

#to_hash ⇒ Object 



13719
13720
13721
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13719

def to_hash
  value
end