Class: Inttegro::Checkout::InvoiceView

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/checkout/invoice_view.rb

Overview

Typed representation of the invoice view 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

#application_id ⇒ String? (readonly)

Value of the application_id field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
end

#beneficiary ⇒ Inttegro::Checkout::InvoiceViewBeneficiary? (readonly)

Value of the beneficiary field in the Inttegro API payload.

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

Returns:



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
end

#created_at ⇒ Time (readonly)

Value of the created_at field in the Inttegro API payload.

Required in the API payload. Wire name: created_at.

Returns:

  • (Time) 


75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
end

#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:



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
end

#due_at ⇒ Time? (readonly)

Value of the due_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
end

#format_value ⇒ Inttegro::Checkout::InvoiceViewFormat (readonly)

Value of the format field in the Inttegro API payload.

Required in the API payload. Wire name: format.

Returns:



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
end

#id ⇒ String (readonly)

Value of the id field in the Inttegro API payload.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
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) 


75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
end

#status ⇒ Inttegro::Checkout::InvoiceViewStatus? (readonly)

Value of the status field in the Inttegro API payload.

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

Returns:



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/inttegro/checkout/invoice_view.rb', line 75

class InvoiceView < T::Struct
  const :delivery_summary, T.nilable(Inttegro::Order::DocumentDeliverySummary), default: nil
  const :id, String
  const :application_id, T.nilable(String), default: nil
  const :number, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
  const :created_at, Time
  const :due_at, T.nilable(Time), default: nil
  const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
  const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
end