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 



8446
8447
8448
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8446

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



8444
8445
8446
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8444

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



8466
8467
8468
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8466

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



8451
8452
8453
8454
8455
8456
8457
8458
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8451

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



8480
8481
8482
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8480

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.



8487
8488
8489
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8487

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



8461
8462
8463
8464
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8461

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.



8473
8474
8475
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8473

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

Instance Method Details

#to_hash ⇒ Object 



8491
8492
8493
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8491

def to_hash
  value
end