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.



17436
17437
17438
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17436

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



17434
17435
17436
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17434

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



17456
17457
17458
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17456

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



17441
17442
17443
17444
17445
17446
17447
17448
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17441

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



17470
17471
17472
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17470

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.



17477
17478
17479
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17477

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



17451
17452
17453
17454
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17451

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.



17463
17464
17465
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17463

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

Instance Method Details

#to_hash ⇒ Object 



17481
17482
17483
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17481

def to_hash
  value
end