Class: Inttegro::Shared::ShippingDetails

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

Overview

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

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



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

class ShippingDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :fee, Inttegro::Money::AmountParams
end

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

Value of the fee field in the Inttegro API payload.

Required in the API payload. Wire name: fee.

Returns:



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

class ShippingDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :fee, Inttegro::Money::AmountParams
end

#id ⇒ String? (readonly)

Unique ID for this shipping charge

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

Returns:

  • (String, nil) 


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

class ShippingDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :fee, 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) 


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

class ShippingDetails < T::Struct
  const :id, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :fee, Inttegro::Money::AmountParams
end