Class: Inttegro::Shared::FeeDetails

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

Overview

Typed representation of the fee details 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

#amount ⇒ Inttegro::Money::AmountParams (readonly)

Value of the amount field in the Inttegro API payload.

Required in the API payload. Wire name: amount.

Returns:



56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/shared/fee_details.rb', line 56

class FeeDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :amount, Inttegro::Money::AmountParams
end

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



56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/shared/fee_details.rb', line 56

class FeeDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :amount, Inttegro::Money::AmountParams
end

#description ⇒ String? (readonly)

Customer-facing description for this fee

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/shared/fee_details.rb', line 56

class FeeDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :amount, Inttegro::Money::AmountParams
end

#id ⇒ String? (readonly)

Fee identifier

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/shared/fee_details.rb', line 56

class FeeDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :amount, Inttegro::Money::AmountParams
end

#label ⇒ String? (readonly)

Customer-facing label for this fee

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/shared/fee_details.rb', line 56

class FeeDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :amount, Inttegro::Money::AmountParams
end

#tax_code ⇒ String? (readonly)

The tax classification code for the shipping fee

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/shared/fee_details.rb', line 56

class FeeDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :amount, Inttegro::Money::AmountParams
end