Class: Io::Flow::V0::Models::B2bCreditMemo

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

The b2b credit memo represents a refund transaction between Flow and one of our clients

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ B2bCreditMemo

Returns a new instance of B2bCreditMemo.



23612
23613
23614
23615
23616
23617
23618
23619
23620
23621
23622
23623
23624
23625
23626
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23612

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :number, :buyer, :seller, :status, :date, :key, :invoice, :lines, :documents, :attributes], 'B2bCreditMemo')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @number = HttpClient::Preconditions.assert_class('number', opts.delete(:number), String)
  @buyer = (x = opts.delete(:buyer); x.is_a?(::Io::Flow::V0::Models::MerchantOfRecordEntity) ? x : ::Io::Flow::V0::Models::MerchantOfRecordEntity.new(x))
  @seller = (x = opts.delete(:seller); x.is_a?(::Io::Flow::V0::Models::MerchantOfRecordEntity) ? x : ::Io::Flow::V0::Models::MerchantOfRecordEntity.new(x))
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::ConsumerInvoiceStatus) ? x : ::Io::Flow::V0::Models::ConsumerInvoiceStatus.apply(x))
  @date = HttpClient::Preconditions.assert_class('date', HttpClient::Helper.to_date_time_iso8601(opts.delete(:date)), DateTime)
  @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
  @invoice = (x = opts.delete(:invoice); x.is_a?(::Io::Flow::V0::Models::B2bInvoiceReference) ? x : ::Io::Flow::V0::Models::B2bInvoiceReference.new(x))
  @lines = HttpClient::Preconditions.assert_class('lines', opts.delete(:lines), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ConsumerInvoiceLine) ? x : ::Io::Flow::V0::Models::ConsumerInvoiceLine.from_json(x)) }
  @documents = HttpClient::Preconditions.assert_class('documents', opts.delete(:documents), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ConsumerInvoiceDocument) ? x : ::Io::Flow::V0::Models::ConsumerInvoiceDocument.new(x)) }
  @attributes = HttpClient::Preconditions.assert_class('attributes', opts.delete(:attributes), Hash).inject({}) { |h, d| h[d[0]] = HttpClient::Preconditions.assert_class('attributes', d[1], String); h }
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def attributes
  @attributes
end

#buyer ⇒ Object (readonly)

Returns the value of attribute buyer.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def buyer
  @buyer
end

#date ⇒ Object (readonly)

Returns the value of attribute date.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def date
  @date
end

#documents ⇒ Object (readonly)

Returns the value of attribute documents.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def documents
  @documents
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def id
  @id
end

#invoice ⇒ Object (readonly)

Returns the value of attribute invoice.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def invoice
  @invoice
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def key
  @key
end

#lines ⇒ Object (readonly)

Returns the value of attribute lines.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def lines
  @lines
end

#number ⇒ Object (readonly)

Returns the value of attribute number.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def number
  @number
end

#seller ⇒ Object (readonly)

Returns the value of attribute seller.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def seller
  @seller
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



23610
23611
23612
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23610

def status
  @status
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



23632
23633
23634
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23632

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

#to_hash ⇒ Object 



23636
23637
23638
23639
23640
23641
23642
23643
23644
23645
23646
23647
23648
23649
23650
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23636

def to_hash
  {
    :id => id,
    :number => number,
    :buyer => buyer.to_hash,
    :seller => seller.to_hash,
    :status => status.value,
    :date => date,
    :key => key,
    :invoice => invoice.to_hash,
    :lines => lines.map { |o| o.to_hash },
    :documents => documents.map { |o| o.to_hash },
    :attributes => attributes
  }
end

#to_json ⇒ Object 



23628
23629
23630
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23628

def to_json
  JSON.dump(to_hash)
end