Class: Inttegro::Order::DocumentDeliveryResult

Inherits:

T::Struct

• Object
• T::Struct
• Inttegro::Order::DocumentDeliveryResult

Defined in:

lib/inttegro/order/document_delivery_result.rb

Overview

Response returned by deliberate order document delivery endpoints.

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

• #delivery ⇒ Inttegro::Order::DocumentDelivery^? readonly

  Delivery result for one hosted order document link.

• #error ⇒ Inttegro::Shared::ErrorPayload^? readonly

  Standard error response structure returned by all API endpoints.

• #order ⇒ Inttegro::Order^? readonly

  Complete order record with line items, customer details, payment state, and fulfillment information.

Instance Attribute Details

#delivery ⇒ Inttegro::Order::DocumentDelivery^? (readonly)

Delivery result for one hosted order document link.

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

Returns:

• (Inttegro::Order::DocumentDelivery, nil)

# File 'lib/inttegro/order/document_delivery_result.rb', line 40

class DocumentDeliveryResult < T::Struct
  const :delivery, T.nilable(Inttegro::Order::DocumentDelivery), default: nil
  const :error, T.nilable(Inttegro::Shared::ErrorPayload), default: nil
  const :order, T.nilable(Inttegro::Order), default: nil
end

#error ⇒ Inttegro::Shared::ErrorPayload^? (readonly)

Standard error response structure returned by all API endpoints. Provides machine-readable codes, human-readable messages, and actionable guidance for resolution.

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

Returns:

• (Inttegro::Shared::ErrorPayload, nil)

# File 'lib/inttegro/order/document_delivery_result.rb', line 40

class DocumentDeliveryResult < T::Struct
  const :delivery, T.nilable(Inttegro::Order::DocumentDelivery), default: nil
  const :error, T.nilable(Inttegro::Shared::ErrorPayload), default: nil
  const :order, T.nilable(Inttegro::Order), default: nil
end

#order ⇒ Inttegro::Order^? (readonly)

Complete order record with line items, customer details, payment state, and fulfillment information

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

Returns:

• (Inttegro::Order, nil)

# File 'lib/inttegro/order/document_delivery_result.rb', line 40

class DocumentDeliveryResult < T::Struct
  const :delivery, T.nilable(Inttegro::Order::DocumentDelivery), default: nil
  const :error, T.nilable(Inttegro::Shared::ErrorPayload), default: nil
  const :order, T.nilable(Inttegro::Order), default: nil
end