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.



9982
9983
9984
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9982

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



9980
9981
9982
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9980

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



10002
10003
10004
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10002

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



9987
9988
9989
9990
9991
9992
9993
9994
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9987

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



10016
10017
10018
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10016

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.



10023
10024
10025
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10023

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



9997
9998
9999
10000
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9997

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.



10009
10010
10011
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10009

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

Instance Method Details

#to_hash ⇒ Object 



10027
10028
10029
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10027

def to_hash
  value
end