Class: Io::Flow::V0::Models::FulfillmentCompleteCancellationForm

Inherits:

Object

• Object
• Io::Flow::V0::Models::FulfillmentCompleteCancellationForm

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Overview

Changing an order for the purpose of completely cancelling all remaining uncancelled, unshipped lines of an order.

Instance Attribute Summary

• #change_source ⇒ Object readonly

  Returns the value of attribute change_source.

• #reason ⇒ Object readonly

  Returns the value of attribute reason.

Instance Method Summary

• #copy(incoming = {}) ⇒ Object
• #initialize(incoming = {}) ⇒ FulfillmentCompleteCancellationForm constructor

  A new instance of FulfillmentCompleteCancellationForm.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ FulfillmentCompleteCancellationForm

Returns a new instance of FulfillmentCompleteCancellationForm.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18872

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:reason], 'FulfillmentCompleteCancellationForm')
  @change_source = (x = (x = opts.delete(:change_source); x.nil? ? "fulfillment" : x); x.is_a?(::Io::Flow::V0::Models::OrderChangeSource) ? x : ::Io::Flow::V0::Models::OrderChangeSource.apply(x))
  @reason = (x = opts.delete(:reason); x.is_a?(::Io::Flow::V0::Models::CancelReason) ? x : ::Io::Flow::V0::Models::CancelReason.apply(x))
end

Instance Attribute Details

#change_source ⇒ Object (readonly)

Returns the value of attribute change_source.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18870

def change_source
  @change_source
end

#reason ⇒ Object (readonly)

Returns the value of attribute reason.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18870

def reason
  @reason
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18883

def copy(incoming={})
  FulfillmentCompleteCancellationForm.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18887

def to_hash
  {
    :change_source => change_source.value,
    :reason => reason.value
  }
end

#to_json ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18879

def to_json
  JSON.dump(to_hash)
end