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.



10471
10472
10473
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10471

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



10469
10470
10471
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10469

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



10491
10492
10493
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10491

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



10476
10477
10478
10479
10480
10481
10482
10483
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10476

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



10505
10506
10507
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10505

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.



10512
10513
10514
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10512

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



10486
10487
10488
10489
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10486

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.



10498
10499
10500
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10498

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

Instance Method Details

#to_hash ⇒ Object 



10516
10517
10518
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10516

def to_hash
  value
end