Class: Inttegro::Shared::InvoiceSettings

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/shared/invoice_settings.rb

Overview

Order-level invoice rendering data. Pages uses this data when rendering invoice web and download views.

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

#custom_data ⇒ Inttegro::CustomData? (readonly)

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.

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

Returns:



45
46
47
48
49
50
 
# File 'lib/inttegro/shared/invoice_settings.rb', line 45

class InvoiceSettings < T::Struct
  const :number, T.nilable(String), default: nil
  const :memo, T.nilable(String), default: nil
  const :footer, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
end

#footer ⇒ String? (readonly)

Optional invoice footer.

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

Returns:

  • (String, nil) 


45
46
47
48
49
50
 
# File 'lib/inttegro/shared/invoice_settings.rb', line 45

class InvoiceSettings < T::Struct
  const :number, T.nilable(String), default: nil
  const :memo, T.nilable(String), default: nil
  const :footer, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
end

#memo ⇒ String? (readonly)

Optional invoice memo.

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

Returns:

  • (String, nil) 


45
46
47
48
49
50
 
# File 'lib/inttegro/shared/invoice_settings.rb', line 45

class InvoiceSettings < T::Struct
  const :number, T.nilable(String), default: nil
  const :memo, T.nilable(String), default: nil
  const :footer, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
end

#number ⇒ String? (readonly)

Optional invoice number. When omitted, invoice delivery falls back to the order number and then the order ID for labels.

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

Returns:

  • (String, nil) 


45
46
47
48
49
50
 
# File 'lib/inttegro/shared/invoice_settings.rb', line 45

class InvoiceSettings < T::Struct
  const :number, T.nilable(String), default: nil
  const :memo, T.nilable(String), default: nil
  const :footer, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
end