Class: Increase::Models::PhysicalCard::Shipment::Tracking

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/physical_card.rb

Overview

See Also:

Defined Under Namespace

Classes: Update

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from Increase::Internal::Type::BaseModel

Instance Attribute Details

#number ⇒ String?

The tracking number. Not available for USPS shipments.

Returns:

  • (String, nil) 


319
 
# File 'lib/increase/models/physical_card.rb', line 319

required :number, String, nil?: true

#return_number ⇒ String?

For returned shipments, the tracking number of the return shipment.

Returns:

  • (String, nil) 


325
 
# File 'lib/increase/models/physical_card.rb', line 325

required :return_number, String, nil?: true

#return_reason ⇒ String?

For returned shipments, this describes why the package was returned.

Returns:

  • (String, nil) 


331
 
# File 'lib/increase/models/physical_card.rb', line 331

required :return_reason, String, nil?: true

#shipped_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the fulfillment provider marked the card as ready for pick-up by the shipment carrier.

Returns:

  • (Time) 


339
 
# File 'lib/increase/models/physical_card.rb', line 339

required :shipped_at, Time

#updates ⇒ Array<Increase::Models::PhysicalCard::Shipment::Tracking::Update>

Tracking updates relating to the physical card’s delivery.

Returns:



345
346
 
# File 'lib/increase/models/physical_card.rb', line 345

required :updates,
-> { Increase::Internal::Type::ArrayOf[Increase::PhysicalCard::Shipment::Tracking::Update] }