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.



13377
13378
13379
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13377

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



13375
13376
13377
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13375

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



13397
13398
13399
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13397

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



13382
13383
13384
13385
13386
13387
13388
13389
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13382

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



13411
13412
13413
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13411

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.



13418
13419
13420
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13418

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



13392
13393
13394
13395
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13392

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.



13404
13405
13406
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13404

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

Instance Method Details

#to_hash ⇒ Object 



13422
13423
13424
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13422

def to_hash
  value
end