Class: Inttegro::Product::Shipment

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/product/shipment.rb

Overview

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

#delivery ⇒ Inttegro::Product::Delivery? (readonly)

Delivery fulfillment marker.

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

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/product/shipment.rb', line 59

class Shipment < T::Struct
  const :type, Inttegro::Product::ShipmentType
  const :delivery, T.nilable(Inttegro::Product::Delivery), default: nil
  const :download, T.nilable(Inttegro::Product::Download), default: nil
  const :render, T.nilable(Inttegro::Product::Render), default: nil
  const :service, T.nilable(Inttegro::Product::Service), default: nil
  const :stream, T.nilable(Inttegro::Product::Stream), default: nil
end

#download ⇒ Inttegro::Product::Download? (readonly)

Download fulfillment marker.

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

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/product/shipment.rb', line 59

class Shipment < T::Struct
  const :type, Inttegro::Product::ShipmentType
  const :delivery, T.nilable(Inttegro::Product::Delivery), default: nil
  const :download, T.nilable(Inttegro::Product::Download), default: nil
  const :render, T.nilable(Inttegro::Product::Render), default: nil
  const :service, T.nilable(Inttegro::Product::Service), default: nil
  const :stream, T.nilable(Inttegro::Product::Stream), default: nil
end

#render ⇒ Inttegro::Product::Render? (readonly)

Rendered fulfillment marker.

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

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/product/shipment.rb', line 59

class Shipment < T::Struct
  const :type, Inttegro::Product::ShipmentType
  const :delivery, T.nilable(Inttegro::Product::Delivery), default: nil
  const :download, T.nilable(Inttegro::Product::Download), default: nil
  const :render, T.nilable(Inttegro::Product::Render), default: nil
  const :service, T.nilable(Inttegro::Product::Service), default: nil
  const :stream, T.nilable(Inttegro::Product::Stream), default: nil
end

#service ⇒ Inttegro::Product::Service? (readonly)

Service fulfillment marker.

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

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/product/shipment.rb', line 59

class Shipment < T::Struct
  const :type, Inttegro::Product::ShipmentType
  const :delivery, T.nilable(Inttegro::Product::Delivery), default: nil
  const :download, T.nilable(Inttegro::Product::Download), default: nil
  const :render, T.nilable(Inttegro::Product::Render), default: nil
  const :service, T.nilable(Inttegro::Product::Service), default: nil
  const :stream, T.nilable(Inttegro::Product::Stream), default: nil
end

#stream ⇒ Inttegro::Product::Stream? (readonly)

Streaming fulfillment marker.

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

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/product/shipment.rb', line 59

class Shipment < T::Struct
  const :type, Inttegro::Product::ShipmentType
  const :delivery, T.nilable(Inttegro::Product::Delivery), default: nil
  const :download, T.nilable(Inttegro::Product::Download), default: nil
  const :render, T.nilable(Inttegro::Product::Render), default: nil
  const :service, T.nilable(Inttegro::Product::Service), default: nil
  const :stream, T.nilable(Inttegro::Product::Stream), default: nil
end

#type ⇒ Inttegro::Product::ShipmentType (readonly)

Value of the type field in the Inttegro API payload.

Required in the API payload. Wire name: type.

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/product/shipment.rb', line 59

class Shipment < T::Struct
  const :type, Inttegro::Product::ShipmentType
  const :delivery, T.nilable(Inttegro::Product::Delivery), default: nil
  const :download, T.nilable(Inttegro::Product::Download), default: nil
  const :render, T.nilable(Inttegro::Product::Render), default: nil
  const :service, T.nilable(Inttegro::Product::Service), default: nil
  const :stream, T.nilable(Inttegro::Product::Stream), default: nil
end