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.



8751
8752
8753
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8751

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



8749
8750
8751
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8749

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



8771
8772
8773
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8771

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



8756
8757
8758
8759
8760
8761
8762
8763
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8756

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



8785
8786
8787
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8785

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.



8792
8793
8794
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8792

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



8766
8767
8768
8769
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8766

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.



8778
8779
8780
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8778

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

Instance Method Details

#to_hash ⇒ Object 



8796
8797
8798
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8796

def to_hash
  value
end