Class: Inttegro::Order::Invoice

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/order/invoice.rb

Overview

Typed representation of the invoice object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_summary ⇒ Inttegro::Order::DocumentDeliverySummary? (readonly)

Bounded aggregate of Chime-accepted sends for one generated order document.

Optional in the API payload; omitted values default to nil. Wire name: delivery_summary.

Returns:



37
38
39
40
41
 
# File 'lib/inttegro/order/invoice.rb', line 37

class Invoice < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :number, T.nilable(String), default: nil
  const :format_value, Inttegro::Order::InvoiceFormat, name: "format"
end

#format_value ⇒ Inttegro::Order::InvoiceFormat (readonly)

Value of the format field in the Inttegro API payload.

Required in the API payload. Wire name: format.

Returns:



37
38
39
40
41
 
# File 'lib/inttegro/order/invoice.rb', line 37

class Invoice < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :number, T.nilable(String), default: nil
  const :format_value, Inttegro::Order::InvoiceFormat, name: "format"
end

#number ⇒ String? (readonly)

Value of the number field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: number.

Returns:

  • (String, nil) 


37
38
39
40
41
 
# File 'lib/inttegro/order/invoice.rb', line 37

class Invoice < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :number, T.nilable(String), default: nil
  const :format_value, Inttegro::Order::InvoiceFormat, name: "format"
end