Class: Io::Flow::V0::Models::ConsumerInvoice

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

Overview

The consumer invoice represents the details of a set of items from a given order. This may represent either the full order or a partial fulfillment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ConsumerInvoice

Returns a new instance of ConsumerInvoice.



36393
36394
36395
36396
36397
36398
36399
36400
36401
36402
36403
36404
36405
36406
36407
36408
36409
36410
36411
36412
36413
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36393

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :number, :status, :date, :key, :order, :entity, :payments, :destination, :lines, :documents, :attributes], 'ConsumerInvoice')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @number = HttpClient::Preconditions.assert_class('number', opts.delete(:number), String)
  @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)
  @order = (x = opts.delete(:order); x.is_a?(::Io::Flow::V0::Models::ConsumerInvoiceOrderSummary) ? x : ::Io::Flow::V0::Models::ConsumerInvoiceOrderSummary.new(x))
  @entity = (x = opts.delete(:entity); x.is_a?(::Io::Flow::V0::Models::MerchantOfRecordEntity) ? x : ::Io::Flow::V0::Models::MerchantOfRecordEntity.new(x))
  @payments = HttpClient::Preconditions.assert_class('payments', opts.delete(:payments), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ConsumerInvoicePayment) ? x : ::Io::Flow::V0::Models::ConsumerInvoicePayment.new(x)) }
  @center = (x = opts.delete(:center); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ConsumerInvoiceCenterReference) ? x : ::Io::Flow::V0::Models::ConsumerInvoiceCenterReference.new(x)))
  @destination = (x = opts.delete(:destination); x.is_a?(::Io::Flow::V0::Models::OrderAddress) ? x : ::Io::Flow::V0::Models::OrderAddress.new(x))
  @billing_address = (x = opts.delete(:billing_address); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::BillingAddress) ? x : ::Io::Flow::V0::Models::BillingAddress.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 }
  @tax_registration = (x = opts.delete(:tax_registration); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::TaxRegistration) ? x : ::Io::Flow::V0::Models::TaxRegistration.new(x)))
  @customer_type = (x = opts.delete(:customer_type); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ConsumerInvoiceCustomerType) ? x : ::Io::Flow::V0::Models::ConsumerInvoiceCustomerType.apply(x)))
  @estimated_delivery_date = (x = opts.delete(:estimated_delivery_date); x.nil? ? nil : HttpClient::Preconditions.assert_class('estimated_delivery_date', HttpClient::Helper.to_date_time_iso8601(x), DateTime))
end

Instance Attribute Details

#attributesObject (readonly)

Returns the value of attribute attributes.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def attributes
  @attributes
end

#billing_addressObject (readonly)

Returns the value of attribute billing_address.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def billing_address
  @billing_address
end

#centerObject (readonly)

Returns the value of attribute center.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def center
  @center
end

#customer_typeObject (readonly)

Returns the value of attribute customer_type.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def customer_type
  @customer_type
end

#dateObject (readonly)

Returns the value of attribute date.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def date
  @date
end

#destinationObject (readonly)

Returns the value of attribute destination.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def destination
  @destination
end

#documentsObject (readonly)

Returns the value of attribute documents.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def documents
  @documents
end

#entityObject (readonly)

Returns the value of attribute entity.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def entity
  @entity
end

#estimated_delivery_dateObject (readonly)

Returns the value of attribute estimated_delivery_date.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def estimated_delivery_date
  @estimated_delivery_date
end

#idObject (readonly)

Returns the value of attribute id.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def id
  @id
end

#keyObject (readonly)

Returns the value of attribute key.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def key
  @key
end

#linesObject (readonly)

Returns the value of attribute lines.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def lines
  @lines
end

#numberObject (readonly)

Returns the value of attribute number.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def number
  @number
end

#orderObject (readonly)

Returns the value of attribute order.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def order
  @order
end

#paymentsObject (readonly)

Returns the value of attribute payments.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def payments
  @payments
end

#statusObject (readonly)

Returns the value of attribute status.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def status
  @status
end

#tax_registrationObject (readonly)

Returns the value of attribute tax_registration.



36391
36392
36393
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36391

def tax_registration
  @tax_registration
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



36419
36420
36421
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36419

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

#to_hashObject



36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
36434
36435
36436
36437
36438
36439
36440
36441
36442
36443
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36423

def to_hash
  {
    :id => id,
    :number => number,
    :status => status.value,
    :date => date,
    :key => key,
    :order => order.to_hash,
    :entity => entity.to_hash,
    :payments => payments.map { |o| o.to_hash },
    :center => center.nil? ? nil : center.to_hash,
    :destination => destination.to_hash,
    :billing_address => billing_address.nil? ? nil : billing_address.to_hash,
    :lines => lines.map { |o| o.to_hash },
    :documents => documents.map { |o| o.to_hash },
    :attributes => attributes,
    :tax_registration => tax_registration.nil? ? nil : tax_registration.to_hash,
    :customer_type => customer_type.nil? ? nil : customer_type.value,
    :estimated_delivery_date => estimated_delivery_date
  }
end

#to_jsonObject



36415
36416
36417
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36415

def to_json
  JSON.dump(to_hash)
end