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.



8410
8411
8412
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8410

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



8408
8409
8410
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8408

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



8430
8431
8432
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8430

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



8415
8416
8417
8418
8419
8420
8421
8422
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8415

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



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

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.



8451
8452
8453
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8451

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



8425
8426
8427
8428
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8425

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.



8437
8438
8439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8437

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

Instance Method Details

#to_hash ⇒ Object 



8455
8456
8457
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8455

def to_hash
  value
end