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.



9622
9623
9624
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9622

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



9620
9621
9622
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9620

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



9642
9643
9644
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9642

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



9627
9628
9629
9630
9631
9632
9633
9634
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9627

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



9656
9657
9658
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9656

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.



9663
9664
9665
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9663

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



9637
9638
9639
9640
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9637

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.



9649
9650
9651
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9649

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

Instance Method Details

#to_hash ⇒ Object 



9667
9668
9669
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9667

def to_hash
  value
end