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.



12043
12044
12045
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12043

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



12041
12042
12043
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12041

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



12063
12064
12065
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12063

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



12048
12049
12050
12051
12052
12053
12054
12055
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12048

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



12077
12078
12079
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12077

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.



12084
12085
12086
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12084

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



12058
12059
12060
12061
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12058

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.



12070
12071
12072
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12070

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

Instance Method Details

#to_hash ⇒ Object 



12088
12089
12090
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12088

def to_hash
  value
end