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.



10718
10719
10720
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10718

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



10716
10717
10718
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10716

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



10738
10739
10740
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10738

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



10723
10724
10725
10726
10727
10728
10729
10730
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10723

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



10752
10753
10754
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10752

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.



10759
10760
10761
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10759

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



10733
10734
10735
10736
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10733

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.



10745
10746
10747
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10745

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

Instance Method Details

#to_hash ⇒ Object 



10763
10764
10765
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10763

def to_hash
  value
end